[clinton/Smoothieware.git] / README.creole

Current build status: {{https://travis-ci.org/Smoothieware/Smoothieware.svg?branch=edge}}

==Overview
Smoothie is a free, opensource, high performance G-code interpreter and CNC controller written in Object-Oriented C++ for the LPC17xx micro-controller ( ARM Cortex M3 architecture ). It will run on a mBed, a LPCXpresso, a SmoothieBoard, R2C2 or any other LPC17xx-based board. The motion control part is a port of the awesome grbl.

Documentation can be found here : [[http://smoothieware.org/]]

NOTE it is not necessary to build Smoothie yourself unless you want to. prebuilt binaries are available here: [[http://triffid-hunter.no-ip.info/Smoothie.html|Nightly builds]] and here: [[https://github.com/Smoothieware/Smoothieware/blob/edge/FirmwareBin/firmware.bin?raw=true|recent stable build]]

==Quick Start
These are the quick steps to get Smoothie dependencies installed on your computer:
* Pull down a clone of the Smoothie github project to your local machine.
* In the root subdirectory of the cloned Smoothie project, there are install scripts for the supported platforms.  Run the install script appropriate for your platform:
** Windows: win_install.cmd
** OS X: mac_install
** Linux: linux_install
* You can then run the BuildShell script which will be created during the install to properly configure the PATH environment variable to point to the required version of GCC for ARM which was just installed on your machine.  You may want to edit this script to further customize your development environment.

==Building Smoothie
From a shell, switch into the root Smoothie project directory and run:
{{{
make clean
make all
}}}

To upload you can do

{{{
make upload
}}}

if you have dfu-util installed.

Alternatively copy the file LPC1768/main.bin to the sdcard calling it firmware.bin and reset.

==Donate
The Smoothie firmware is free software developed by volunteers. If you find this software useful, want to say thanks and encourage development, please consider a 
[[https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=9QDYFXXBPM6Y6&lc=US&item_name=Smoothieware%20development&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted|Donation]]
Commit	Line	Data
9b072f93	1	Current build status: {{https://travis-ci.org/Smoothieware/Smoothieware.svg?branch=edge}}
ac23ac80	2
8fcce42e AG	3	==Overview
	4	Smoothie is a free, opensource, high performance G-code interpreter and CNC controller written in Object-Oriented C++ for the LPC17xx micro-controller ( ARM Cortex M3 architecture ). It will run on a mBed, a LPCXpresso, a SmoothieBoard, R2C2 or any other LPC17xx-based board. The motion control part is a port of the awesome grbl.
	5
	6	Documentation can be found here : [[http://smoothieware.org/]]
	7
e948d24b	8	NOTE it is not necessary to build Smoothie yourself unless you want to. prebuilt binaries are available here: [[http://triffid-hunter.no-ip.info/Smoothie.html\|Nightly builds]] and here: [[https://github.com/Smoothieware/Smoothieware/blob/edge/FirmwareBin/firmware.bin?raw=true\|recent stable build]]
459fe351	9
8fcce42e	10	==Quick Start
5579f7a8	11	These are the quick steps to get Smoothie dependencies installed on your computer:
8fcce42e	12	* Pull down a clone of the Smoothie github project to your local machine.
5579f7a8	13	* In the root subdirectory of the cloned Smoothie project, there are install scripts for the supported platforms. Run the install script appropriate for your platform:
8fcce42e AG	14	** Windows: win_install.cmd
	15	** OS X: mac_install
	16	** Linux: linux_install
	17	* You can then run the BuildShell script which will be created during the install to properly configure the PATH environment variable to point to the required version of GCC for ARM which was just installed on your machine. You may want to edit this script to further customize your development environment.
	18
8fcce42e AG	19	==Building Smoothie
	20	From a shell, switch into the root Smoothie project directory and run:
	21	{{{
ee07eb7b JM	22	make clean
ee07eb7b JM	23	make all
8fcce42e	24	}}}
ee07eb7b	25
88212b00	26	To upload you can do
ee07eb7b JM	27
	28	{{{
	29	make upload
	30	}}}
	31
88212b00	32	if you have dfu-util installed.
ee07eb7b JM	33
ee07eb7b JM	34	Alternatively copy the file LPC1768/main.bin to the sdcard calling it firmware.bin and reset.
e948d24b JM	35
e948d24b JM	36	==Donate
2163ccd8 JM	37	The Smoothie firmware is free software developed by volunteers. If you find this software useful, want to say thanks and encourage development, please consider a
	38	[[https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=9QDYFXXBPM6Y6&lc=US&item_name=Smoothieware%20development&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted\|Donation]]
	39
	40