diff --git a/docs/Overview.md b/docs/Overview.md index 73342a50..8b221763 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -1,16 +1,20 @@ See [installation](Installation.md) for information on compiling, installing, and running Klipper. Read [features](Features.md) for a -high-level description of useful capabilities. +high-level description of useful capabilities. The history of releases +is available at [releases](Releases.md). -See [code overview](Code_Overview.md) for developer information on the -structure and layout of the Klipper code. +There are also several documents available for developers interested +in understanding how Klipper works: -See [protocol](Protocol.md) for developer information on the messaging -protocol between host and firmware. See also +See [code overview](Code_Overview.md) for information on the structure +and layout of the Klipper code. + +See [protocol](Protocol.md) for information on the messaging protocol +between host and firmware. See also [firmware commands](Firmware_Commands.md) for a high-level description -of some commands implemented in the firmware. +of common commands implemented in the firmware. -See [debugging](Debugging.md) for developer information on how to test -and debug Klipper. +See [debugging](Debugging.md) for information on how to test and debug +Klipper. See [todo](Todo.md) for information on possible future code features. diff --git a/docs/Releases.md b/docs/Releases.md new file mode 100644 index 00000000..41781fe9 --- /dev/null +++ b/docs/Releases.md @@ -0,0 +1,15 @@ +History of Klipper releases. Please see +[installation](Installation.md) for information on installing Klipper. + +Klipper 0.2.0 +============= + +Initial release of Klipper. Available on 20160525. Major features +available in the initial release include: + +* Basic support for cartesian printers (steppers, extruder, heated + bed, cooling fan). +* Support for common g-code commands. Support for interfacing with + OctoPrint. +* Acceleration and lookahead handling +* Support for AVR micro-controllers via standard serial ports