aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorBen V. Brown <[email protected]>2020-12-31 12:52:06 +1100
committerBen V. Brown <[email protected]>2020-12-31 12:52:06 +1100
commite842f8d2921e00503485fe14a4e38c5dabf44851 (patch)
treed31ef1b5809658bd0f0809e090c9f990969a908c /README.md
parentf84dc8937327ff04b354404b38fab1e376355436 (diff)
downloadIronOS-e842f8d2921e00503485fe14a4e38c5dabf44851.tar.gz
IronOS-e842f8d2921e00503485fe14a4e38c5dabf44851.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index e1aa0560..14b5b246 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
![CI](https://github.com/Ralim/ts100/workflows/CI%20Build%20all/badge.svg)
+![GitHub all](https://img.shields.io/github/downloads/ralim/IronOS/total)
+![Latest Release](https://img.shields.io/github/v/release/ralim/IronOS)
# IronOS - Flexible Soldering iron control Firmware
@@ -18,6 +20,7 @@ This project is considered feature complete for use as a soldering iron, *so ple
*This firmware does **NOT** support the USB port while running for changing settings. This is done through the onscreen menu only. Logos are edited using the tool or python script and uploaded in DFU mode.*
+
## Key Features
* PID style iron temperature control
@@ -34,10 +37,14 @@ This project is considered feature complete for use as a soldering iron, *so ple
* Boost mode lets you temporarily change the temperature when soldering (i.e. raise the temperature for short periods of time)
* (TS100/Pinecil) Battery charge level indicator if power source set to a lipo cell count
* (TS80/TS80P/Pinecil) Power bank operating voltage is displayed
-* [Custom boot up logo support](Documentation/Flashing.md)
+* [Custom boot up logo support](Documentation/Logo.md)
* Automatic LCD rotation based on the orientation
-# Menu System
+## Installation
+
+For installation for your device, please refer to the [Flashing Guide](Documentation/Flashing.md).
+
+## Menu System
This new firmware uses a new menu system to allow access to the settings on the device.
When on the main screen, the unit shows prompts for the two most common operations.