make sure the WCS settings are handled correctly in inch mode, report in inches if...
[clinton/Smoothieware.git] / README.creole
index 45c2ad2..05d1c14 100644 (file)
@@ -1,8 +1,12 @@
+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.
@@ -15,6 +19,22 @@ These are the quick steps to get Smoothie dependencies installed on your compute
 ==Building Smoothie
 From a shell, switch into the root Smoothie project directory and run:
 {{{
-make clean all
-make flash
+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]]
+
+