Refactor the Makefile into pieces. This commit inspired by AncientGeek, my hatred...
[freeems-vanilla.git] / README.md
blobd49f3ea3b0ae06799281b731b0fc7dd588b4b6c3
1 # FreeEMS - TRUE DIY Engine Management
3 ### Introduction
5 FreeEMS - The open source engine management system!
7 Please see [FreeEMS.org](http://freeems.org) for the most up to date information and links!
9 To casually follow the highlights you can subscribe to our [facebook page](http://www.facebook.com/FreeEMS)!
11 Before using FreeEMS, please read the [disclaimer](http://www.diyefi.org/disclaimer.htm)!
13 If you're wondering why this project was started have a look at [this page](http://www.diyefi.org/why.htm).
15 ### Obtaining the firmware
17 The best way to get the latest development firmware is from the [build server!](http://builds.freeems.org)
19 ### Building the firmware
21 If you want to build your own firmware for some reason such as customisations, read below.
23 Ensure that you have the latest release or latest code from the [github repository](http://github.com/fredcooke/freeems-vanilla).
25 To build this firmware you need the latest build environment from the [tools site](http://tools.diyefi.org).
27 You also need an up to date version of git available on the command line.
29 With these prerequisites met, simply type 'make' and choose an option!
31 ### Loading the firmware
33 **Please note**: hcs12mem is no longer capable of loading the firmware unassisted.
35 You need either FreeEMS Loader or mtxloader. The former is a standalone app,
36 and the latter is packaged with MTX.
38 If you are working on the dev board, you need to flip the load/run switch
39 to "load" and depress the reset button, or send a reset packet, prior to
40 flashing.  Return the switch to the "run" position when complete.
42 ### Tuning your FreeEMS
44 Tuning is currently done with a combination of techniques. For the full story
45 check out [this thread](http://forum.diyefi.org/viewtopic.php?f=54&t=1166)
46 and the threads that it links to.
48 ### Footnote
50 Please post any and all feedback on code, documentation, the system, anything
51 at all, even subtle and minor stuff to [the forum](http://forum.diyefi.org).
53 Thanks for playing with FreeEMS :-)
55 Good luck and regards,
57 Fred.