File	Date	Author	Commit
.settings	2016-05-23	Ondrej Sienczak	[508193] Updated encoder panel
arduino	2016-05-13	Ondrej Sienczak	[b8c57b] KNM as interface (virtual methods)
src	2016-06-26	Ondrej Sienczak	[c93c05] Prepare release 2.7
unit	2016-04-29	Ondrej Sienczak	[cf572f] Print command diagnostics.
.astylerc	2016-05-09	Ondrej Sienczak	[5b2f33] Fixed homing endstop A
.cproject	2016-04-24	Ondrej Sienczak	[c311d5] Compilable firmware.
.gitignore	2016-06-13	Ondrej Sienczak	[4619b1] Started work on HAL SPI
.project	2016-04-20	Ondrej Sienczak	[807207] Sync
README.TXT	2016-01-10	Ondrej Sienczak	[09cd04] Added readme.
build.bash	2016-04-26	Ondrej Sienczak	[eb9b06] Release 2.4
build.cmd	2016-04-26	Ondrej Sienczak	[eb9b06] Release 2.4
build_file.cmd	2016-01-09	Ondrej Sienczak	[3b4642] Added build support for Win32 and Linux (avr-gc...

Read Me

========
Firmware
========

This firmware was derived from Marlin firmware (see http://reprap.org/wiki/Marlin),
but hardware support and some code was reduced to make this code little more simple,
legible and easy to modify/extend by new kinematics (e.g. such as Simpson GUS, CoreXY,
or what ever).

Main aim of this firmware is to separate functional modules such as mechanics,
kinematics, gcode processor and so on. I also decided to remake as much firmware parts
as possible to C++ to make coding and maintainance more simple.

Actual version only support (is tested) on following hardware configuration:

- Arduino MEGA 2560 board
- Ramps 1.3/1.4
- 2004 Smart LCD for RepRap

Printer using this firmware is Rebel II (I uses modified version with dual head). There also
will be some homemade CoreXY in near future. There was also Simpson GUS kinematics made, but
development of this kinematics was stopped due to broken mechanics (nice concept, but no time
and space in my flat to repare it :-/). However codes are still remaining inthere as example
for creation on any kind of non-linear kinematics.



==============
Build firmware
==============

Ubuntu
------

1) Install Arduino IDE. We don't use IDE itself, but this instalation also install
   avr-gcc as required dependencies:

   sudo apt-get install arduino


2) Go to project root directory (marlinpp-code)

3) Run build.bash


   ./build.bash



Windows
-------

Windows compilers are part of sources, therefore you don't need to install them.

1) Go to project root directory (marlinpp-code)

2) Run build.cmd


   build.cmd



=========
Languages
=========

Custom language translation can be used for menu and messages shown on display.
There is English used by default, but you can specify your custom language by
defining suitable language macro. E.g. to use Czech language support use following:


./build.bash -DLANGUAGE=LANGUAGE_CZ


Currently are available following languages mutations:

LANGUAGE_CZ - Czech