README.creole

   1 Current build status: {{https://travis-ci.org/Smoothieware/Smoothieware.svg?branch=edge}}
   2
   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
   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]]
   9
  10 ==Quick Start
  11 These are the quick steps to get Smoothie dependencies installed on your computer:
  12 * Pull down a clone of the Smoothie github project to your local machine.
  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:
  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
  19 ==Building Smoothie
  20 Follow this guide... [[http://smoothieware.org/compiling-smoothie]]
  21
  22 In short...
  23 From a shell, switch into the root Smoothie project directory and run:
  24 {{{
  25 make clean
  26 make all
  27 }}}
  28
  29 To upload you can do
  30
  31 {{{
  32 make upload
  33 }}}
  34
  35 if you have dfu-util installed.
  36
  37 Alternatively copy the file LPC1768/main.bin to the sdcard calling it firmware.bin and reset.
  38
  39 == Filing issues (for bugs ONLY)
  40 Please follow this guide [[https://github.com/Smoothieware/Smoothieware/blob/edge/ISSUE_TEMPLATE.md]]
  41
  42 ==Contributing
  43
  44 Please take a look at :
  45
  46 * http://smoothieware.org/coding-standards
  47 * http://smoothieware.org/developers-guide
  48 * http://smoothieware.org/contribution-guidlines
  49
  50 Contributions very welcome !
  51
  52 ==Donate
  53 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
  54 [[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]]
  55
  56 ==License
  57
  58 Smoothieware is released under the GNU GPL v3, which you can find at http://www.gnu.org/licenses/gpl-3.0.en.html
  59
  60