[clinton/Smoothieware.git] / README.creole

==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/]]

==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 all
make flash
}}}
Commit	Line	Data
8fcce42e AG	1	==Overview
	2	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.
	3
	4	Documentation can be found here : [[http://smoothieware.org/]]
	5
	6	==Quick Start
5579f7a8	7	These are the quick steps to get Smoothie dependencies installed on your computer:
8fcce42e	8	* Pull down a clone of the Smoothie github project to your local machine.
5579f7a8	9	* 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	10	** Windows: win_install.cmd
	11	** OS X: mac_install
	12	** Linux: linux_install
	13	* 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.
	14
8fcce42e AG	15	==Building Smoothie
	16	From a shell, switch into the root Smoothie project directory and run:
	17	{{{
	18	make clean all
	19	make flash
	20	}}}