README.creole

   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 NOTE it is not necessary to build Smoothie yourself unless you want to. prebuilt binaries are availble here http://builds.smoothieware.org/
   7
   8 ==Quick Start
   9 These are the quick steps to get Smoothie dependencies installed on your computer:
  10 * Pull down a clone of the Smoothie github project to your local machine.
  11 * 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:
  12 ** Windows: win_install.cmd
  13 ** OS X: mac_install
  14 ** Linux: linux_install
  15 * 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.
  16
  17 === Homebrew
  18 If you're a Mac OS X user who uses [[http://brew.sh/|Homebrew]] (and really, who doesn't?) you can skip the above steps and simply do
  19
  20 NOTE you do this at your own risk please check the source
  21
  22 {{{
  23 brew tap bfoz/embedded
  24 brew install --env=std gcc-arm-embbedded
  25 }}}
  26
  27 After that finishes (it can take awhile) you'll be all set; no need to run mac_install or BuildShell. Enjoy!
  28
  29 ==Building Smoothie
  30 From a shell, switch into the root Smoothie project directory and run:
  31 {{{
  32 make clean
  33 make all
  34 }}}
  35
  36 To upload you can do
  37
  38 {{{
  39 make upload
  40 }}}
  41
  42 if you have dfu-util installed.
  43
  44 Alternatively copy the file LPC1768/main.bin to the sdcard calling it firmware.bin and reset.