[docs] Update docu.
This commit is contained in:
parent
86d8e631d5
commit
b33c073dda
12
README.md
12
README.md
|
@ -11,17 +11,21 @@ This plugin assists in managing and monitoring the [Klipper](https://github.com/
|
||||||
- Dialog to set a coordinate offset for future GCODE move commands.
|
- Dialog to set a coordinate offset for future GCODE move commands.
|
||||||
- Message log displaying messages from Klipper prepended with "//" and "!!".
|
- Message log displaying messages from Klipper prepended with "//" and "!!".
|
||||||
- Basic Klipper configuration editor
|
- Basic Klipper configuration editor
|
||||||
|
- Performance graph displaying key parameters extracted from the Klipper logs.
|
||||||
|
|
||||||
### ToDo
|
### ToDo
|
||||||
- Add a continously updated status display in octoprints navbar.
|
- Add a continously updated status display in octoprints navbar.
|
||||||
|
|
||||||
## Setup
|
## Installation
|
||||||
|
|
||||||
Install via the bundled [Plugin Manager](https://github.com/foosel/OctoPrint/wiki/Plugin:-Plugin-Manager)
|
Install via OctoPrints [Plugin Manager](http://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)
|
||||||
or manually using this URL:
|
or manually using this URL:
|
||||||
|
|
||||||
https://github.com/mmone/OctoPrintKlipper/archive/master.zip
|
https://github.com/mmone/OctoPrintKlipper/archive/master.zip
|
||||||
|
|
||||||
|
## Update
|
||||||
|
|
||||||
|
OctoPrint will inform you when a new version of this plugin becomes available.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
|
@ -48,3 +52,7 @@ Also for the moment this plugin does what I wanted it to do, it is far from fini
|
||||||
|
|
||||||
#### Settings
|
#### Settings
|
||||||
![Settings](docs/assets/img/settings.png)
|
![Settings](docs/assets/img/settings.png)
|
||||||
|
|
||||||
|
#### Performance Graph
|
||||||
|
![Settings](docs/assets/img/performance-graph.png)
|
||||||
|
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 175 KiB |
Binary file not shown.
Before Width: | Height: | Size: 135 KiB After Width: | Height: | Size: 80 KiB |
Loading…
Reference in New Issue