Draft documentation README and BUILDING instructions

BUILDING.md

@@ -0,0 +1,61 @@
+## Build instructions for Original Prusa i3 MK2/S/MM Firmware
+
+### Step 1 - Download and Install/Unpack Arduino
+
+Download and install the Arduino IDE. The most recent version 1.8.5 is available here:
+<a href="https://www.arduino.cc/en/Main/Software" target="_blank">https://www.arduino.cc/en/Main/Software</a>
+
+If you already use another Arduino IDE version for other projects and don't want to upgrade to the latest setup, you may want to install a stand-alone (ZIP file) version rather than using the "Windows Installer".
+
+### Step 2 - Prepare the Arduino toolchain
+
+1. Open the IDE
+2. Open file/preferences and set additional boards manager URL to the RAMBo repository:<br/> <a href="https:// raw.githubusercontent.com/ultimachine/ArduinoAddons/master/package_ultimachine_index.json" target="_blank">https:// raw.githubusercontent.com/ultimachine/ArduinoAddons/master/package_ultimachine_index.json</a>
+3. Open Tools/Boards/Boards Manager and install the RAMBo board:<br/>"<small>**RepRap Arduino-compatible Mother Board (RAMBo)** by **UltiMachine**</small>"
+4. Close the IDE.
+5. Open the IDE and select the RAMBo as target board from the Tools submenu.
+6. Close the IDE
+
+### Step 3 - Download PRUSA i3 MK2 Firmware
+
+You can either clone the prusa3d/Prusa-Firmware repository to a local path or download the ZIP file from and unpack it from here:
+<a href="https://github.com/prusa3d/Prusa-Firmware/tree/MK2" target="_blank">https://github.com/prusa3d/Prusa-Firmware/tree/MK2</a>
+
+Specific released versions of source code in either **.zip** or **.tar.gz** packages can be found here:
+<a href="https://github.com/prusa3d/Prusa-Firmware/releases" target="_blank">https://github.com/prusa3d/Prusa-Firmware/releases</a>
+
+### Step 4 - Configure the Printer Firmware - select variant
+
+The following configurations are availble in the __Prusa-Firmware/Firmware/variants__ directory.
+(See **How-to-choose-firmware.pdf** for help choosing configuration.)
+
+* 1_75mm_MK1-RAMBo10a-E3Dv6full.h
+* 1_75mm_MK1-RAMBo13a-E3Dv6full.h
+* 1_75mm_MK2-MultiMaterial-RAMBo10a-E3Dv6full.h
+* 1_75mm_MK2-MultiMaterial-RAMBo13a-E3Dv6full.h
+* 1_75mm_MK2-RAMBo10a-E3Dv6full.h
+* 1_75mm_MK2-RAMBo13a-E3Dv6full.h
+
+Copy and rename the file representing your configuration to the ``Firmware`` directory as ``Configuration_prusa.h`` Example:
+> $ cp Firmware/variants/1_75mm_MK1-RAMBo13a-E3Dv6full.h Firmware/Configuration_prusa.h
+
+### Step 5 - Build the Firmware
+
+1. Open the IDE
+2. Open firmware project with File -> Open... Navigate to and open:<br/>
+ ``Prusa-Firmware/Firmware/Firmware.ino``
+3. Compile the firmware with Sketch -> Verify/Compile (CTRL-R) --or--
+4. Export the compiled binary with Sketch -> Export compiled Binary (CTRL-ALT-S).<br/>
+You will find the exported binary in ``Prusa-Firmware/Firmware/Firmware.ino.rambo.hex``
+
+
+### Step 6 - Upload the Firmware
+
+You can upload the new firmare to the printer using either:
+
+* The Prusa3D Firmware Updater (download from <a href="https://www.prusa3d.com/drivers/" target="_blank">https://www.prusa3d.com/drivers/</a>)
+
+* Directly via the Arduino IDE (Select Tools -> Port and 115200 baud rate)
+
+* avrdude (either direct or thru OctoPrint, etc.). Example command-line:
+>$ avrdude -v -p m2560 -c wiring -P /dev/ttyUSB0 -b 115200 -U "flash:w:**firmware.hex**:i" -D

README.md

@@ -1,43 +1,34 @@
-# Original Prusa i3 MK2 Firmware
+# Custom Prusa i3 MK2 Firmware [![Build Status](https://travis-ci.org/thess/Prusa-Firmware.svg?branch=private-build2)](https://travis-ci.org/thess/Prusa-Firmware)
 
-## General instructions
+## About this Firmware
 
-Pre-compiled hex output on PRUSA RESEARCH site: http://prusa3d.com/downloads/firmware/
+This custom firmware is forked from the Original Prusa i3 MK2 Firmware (MK2 branch). All changes to the MK2 branch in the Prusa Firmware repository are merged here regularly. It also includes changes like:
 
-Just download and flash it to the electronics
+- PRs from Prusa which have been submitted, but not yet merged into the Prusa-Firmware repo.
+- Experimental features which may or may not work.
+- Fixed bugs as appropriate.
+
+
+## Disclaimer
+
+Please note that this is not the original Prusa i3 MK2 Firmware and if you decide to use it you will do it at your own risk!
+
+
+## Handling Issues and Pull-Requests
+
+If you have an issue with this firmware version, please check first if it also happens with a official released version of Prusa i3 MK2 Firmware. If the problem persists, open an issue at: <a href="https://github.com/prusa3D/Prusa-Firmware/issues" target="_blank">https://github.com/prusa3D/Prusa-Firmware/issues</a>.
+Otherwise, if the problem is not present in the official firmware release, please open an issue here.
+
+If you have something you would like to see in this customization and do not want to submit the changes to Prusa, you may submit a PR to this repository for consideration. In general, you should submit changes to the oficial Prusa Firmware repository so everyone can benefit from them.
+
+## Download of precompiled .hex files
+
+URL of the zip file containing precompiled firmware can be found toward the end of the build log. Click on the button in the right-hand corner of the log to move to the end.
+[Travis CI output](https://travis-ci.org/thess/Prusa-Firmware)
+
+Just download, unzip and choose the version for your configuation, then flash it to the printer.
 
 
 ## Build instructions
 
-### Step 1
+See [BUILDING.md](https://github.com/thess/Prusa-Firmware/blob/private-build2/BUILDING.md)
-
-Install arduino
-
-### Step 2
-
-Remove Liquid Crystal library from your arduino or rename it
-
-### Step 3
-
-Install the arduino addon located in the root of this repo. Don't forget to install correct version!
-
-### Step 4
-
-Copy the configuration file matching your printer from variants folder to the the Firmware folder
-
-### Step 5
-
-Rename it to "Configuration_prusa.h"
-
-### Step 6
-
-Compile the firmware
-
-### Step 7
-
-Upload the firmware to board
-
-
-
-
-