temperaturecontrol: allow setting background tool without activating

[clinton/Smoothieware.git] / README.creole

diff --git a/README.creole b/README.creole
index 45c2ad2..aebe82a 100644 (file)
--- a/README.creole
+++ b/README.creole
@@ -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.
@@ -13,8 +17,44 @@ These are the quick steps to get Smoothie dependencies installed on your compute
 * 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
+Follow this guide... [[http://smoothieware.org/compiling-smoothie]]
+
+In short...
 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.
+
+== Filing issues (for bugs ONLY)
+Please follow this guide [[https://github.com/Smoothieware/Smoothieware/blob/edge/ISSUE_TEMPLATE.md]]
+
+==Contributing
+
+Please take a look at : 
+
+* http://smoothieware.org/coding-standards
+* http://smoothieware.org/developers-guide
+* http://smoothieware.org/contribution-guidlines
+
+Contributions very welcome !
+
+==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]]
+
+==License
+
+Smoothieware is released under the GNU GPL v3, which you can find at http://www.gnu.org/licenses/gpl-3.0.en.html
+
+