mirror of
https://github.com/Ralim/IronOS.git
synced 2025-02-26 07:53:55 +00:00
Generate a mkdocs github page + Migrate documentation links to use it (#1414)
* Approx first pass? * Update docs.yml * Filling out menu * Update GettingStarted.md * Index docs links * Update index.md * Update README.md * Link redirection * More link rewrite * Update HallSensor.md * Split up flashing * Derp * Flashing links
This commit is contained in:
Ben V. Brown
GitHub
35
README.md
35
README.md
@@ -18,29 +18,34 @@ Currently **31** languages are supported. When downloading the firmware for your
|
||||
|
||||
This project is considered feature complete for use as a soldering iron, _so please suggest any feature improvements you would like!_
|
||||
|
||||
_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._
|
||||
_This firmware does **NOT** support the USB port while running for changing settings. This is done through the onscreen menu only. Logos are edited on a computer and flashed like firmware._
|
||||
|
||||
|
||||
| Device | DC | QC | PD | EPR | BLE | Battery | Recommended |
|
||||
|:----------:|:--:|:--:|:--:|:---:|:---:|:-------:|:-----------:|
|
||||
| MHP30 |❌ | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ |
|
||||
| Pinecil V1 |✔️ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ |
|
||||
| Pinecil V2 |✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| TS80P |❌ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ |
|
||||
| TS100 |✔️ | ❌ | ❌ | ❌ | ❌ | ✔️ | ❌ |
|
||||
| TS80 |❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ | ❌ |
|
||||
| Device | DC | QC | PD | EPR | BLE | Battery | Recommended |
|
||||
| :--------: | :-: | :-: | :-: | :-: | :-: | :-----: | :---------: |
|
||||
| MHP30 | ❌ | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ |
|
||||
| Pinecil V1 | ✔️ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ |
|
||||
| Pinecil V2 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| TS80P | ❌ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ |
|
||||
| TS100 | ✔️ | ❌ | ❌ | ❌ | ❌ | ✔️ | ❌ |
|
||||
| TS80 | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ | ❌ |
|
||||
|
||||
\*Please note that Miniware started shipping TS100's using cloned STM32 Chips. While these do work with IronOS, their DFU bootloader works terribly, and it is hard to get it to successfully flash larger firmware images like IronOS without timing out. This is the main reason why the TS100 is **_no longer recommended_**.
|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started with IronOS firmware, please jump to [Getting Started Guide](Documentation/GettingStarted.md).
|
||||
To get started with IronOS firmware, please jump to [Getting Started Guide](https://ralim.github.io/IronOS/GettingStarted/).
|
||||
But the [TL;DR](https://www.merriam-webster.com/dictionary/TL%3BDR) 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).
|
||||
For notes on installation for your device, please refer to the flashing guide for your device:
|
||||
|
||||
- [MHP30](https://ralim.github.io/IronOS/Flashing/MHP30)
|
||||
- [Pinecil V1](https://ralim.github.io/IronOS/Flashing/Pinecil%20V1/)
|
||||
- [Pinecil V2](https://ralim.github.io/IronOS/Flashing/Pinecil%20V2/)
|
||||
- [TS80 / TS80P](https://ralim.github.io/IronOS/Flashing/TS80%28P%29/)
|
||||
- [TS100](https://ralim.github.io/IronOS/Flashing/TS100)
|
||||
|
||||
## Key Features
|
||||
|
||||
@@ -59,7 +64,7 @@ For notes on installation for your device, please refer to the [Flashing Guide](
|
||||
- Boost mode lets you temporarily change the temperature when soldering (i.e. raise the temperature for short periods)
|
||||
- (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/Logo.md)
|
||||
- [Custom boot up logo support](https://ralim.github.io/IronOS/Logo/)
|
||||
- Automatic LCD rotation based on the orientation
|
||||
|
||||
## Menu System
|
||||
@@ -70,9 +75,9 @@ When on the main screen and having the tip plugged in, the unit shows a pair of
|
||||
- Pressing the button near the tip enters the _soldering mode_
|
||||
- Pressing the button near the USB end enters the _settings menu_
|
||||
- When not in _soldering mode_, holding down the button near the tip will enter _soldering temperature adjust mode_ (This is the same as the one in the _soldering mode_, but allows to adjust the temperature before heating up), in _soldering mode_ however this will activate _boost mode_ as long as you hold down the button.
|
||||
- Holding down the button near the USB end will show the _[debug menu](Documentation/DebugMenu.md)._ In _soldering mode_ this ends the heating.
|
||||
- Holding down the button near the USB end will show the _[debug menu](https://ralim.github.io/IronOS/DebugMenu/)._ In _soldering mode_ this ends the heating.
|
||||
|
||||
Operation details are over in the [Menu information.](Documentation/Menu.md)
|
||||
Operation details are over in the [Menu information.](https://ralim.github.io/IronOS/Menu/)
|
||||
|
||||
## Thanks
|
||||
|
||||
|
||||
Reference in New Issue
Block a user