aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorBen V. Brown <[email protected]>2022-01-05 21:24:12 +1100
committerBen V. Brown <[email protected]>2022-01-05 21:24:12 +1100
commit2cac11fdda72d5a92472fba20a9aaf71f8ac9431 (patch)
tree01712c8fc23f2520f1433d2757b346f9da63f2cf /README.md
parentee9a7c7ddba2877c6361e8c8427f8c5a0cc1f7af (diff)
downloadIronOS-2cac11fdda72d5a92472fba20a9aaf71f8ac9431.tar.gz
IronOS-2cac11fdda72d5a92472fba20a9aaf71f8ac9431.zip
Adding a few more notes to the Flashing page
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index 9123a99c..db79e0c8 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
# IronOS - Flexible Soldering iron control Firmware
-_This repository was formerly known as TS100, it's the same great code. Just with more supported devices_
+_This repository was formerly known as TS100, it's the same great code. Just with more supported devices._
Originally conceived as an alternative firmware for the TS100, this firmware has evolved into a complex soldering iron control firmware.
@@ -20,7 +20,13 @@ 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._
-To get started with this firmware, please jump over to [here](Documentation/GettingStarted.md)
+To get started with this firmware, please jump over to [here](Documentation/GettingStarted.md).
+But the TL;DR is to press the button near the front of the iron to heat up. Use the button near the back of the iron to enter the settings menu.
+Long hold the rear button in soldering mode to exit back to the start screen.
+
+## Installation
+
+For notes on installation for your device, please refer to the [Flashing Guide](Documentation/Flashing.md).
## Key Features
@@ -41,10 +47,6 @@ To get started with this firmware, please jump over to [here](Documentation/Gett
- [Custom boot up logo support](Documentation/Logo.md)
- Automatic LCD rotation based on the orientation
-## Installation
-
-For notes on 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.