me/IronOS
1
0
Fork 1
mirror of https://github.com/Ralim/IronOS.git synced 2025-02-26 07:53:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Move related pieces of documentation from wiki to Documentation/ (#1746)

Browse Source 
* Move TS100 info from wiki to Hardware.md

* Move TS80 info from wiki to Hardware.md

* Move TS80P info from wiki to Hardware.md

* Move Pinecil info from wiki to Hardware.md

* Move some info from Home.md wiki to Documentation/index.md

* Fix path inside docker since Dockerfile has been updated to be in the root project tree after starting container

* Move info from Home.md wiki to Documentation/Hardware.md

* mkdocs.yml: swtich config to forked repo for testing formatting online

* Fix formatting

* Fix formatting (md != rtd)

* Fix formatting for index.md

* Revert mkdocs config to original one after testing

* Documentation/: add power sources info

* Documentation/README.md: update with power sources

* tiny fixes with formatting

* Reformat links to stores

* Fix footnote on _default_ charger for TS80P

* Revert mkdocs config

* Fix footnote about wattage for QC, try fix table in index.md
This commit is contained in:
Ivan Zorin
2023-07-20 04:55:08 +03:00
committed by GitHub
parent 297a4dffa5
commit 1c9d3940ca
7 changed files with 161 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/index.md
View File

@@ -8,7 +8,7 @@ For soldering irons that are designed to be powered by batteries (TS100 & Pineci
Currently **31** languages are supported. When downloading the firmware for your soldering iron, take note of the language code in the file name.
This project is considered feature complete for use as a soldering iron, _so please suggest any feature improvements you would like!_
This project is considered stable & feature complete for everyday use with a supported device, _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 on a computer and flashed like firmware._
@@ -39,6 +39,12 @@ For notes on installation for your device, please refer to the flashing guide fo
- [TS80 / TS80P](https://ralim.github.io/IronOS/Flashing/TS80%28P%29/)
- [TS100](https://ralim.github.io/IronOS/Flashing/TS100)
But the _generic_ [TL;DR](https://www.merriam-webster.com/dictionary/TL%3BDR) is to:
- [download firmware from here](https://github.com/Ralim/IronOS/releases) for the correct model with suitable language support;
- put a device into DFU/bootloader mode (usually by keep holding A/+/front button while connecting a device to power source to power device on);
- flash the firmware by drag-n-drop the firmware file using a file manager of your OS **or** using a separate flashing tool.
## Key Features
- PID style iron temperature control
@@ -74,17 +80,21 @@ Operation details are over in the [Menu information.](https://ralim.github.io/Ir
## Feedback
If you would like to:
- report any issue related to IronOS
- request a feature
- provide some suggestion
then you can [fill this form](https://github.com/Ralim/IronOS/issues/new/choose) using github account[^gh].
then you can [fill this form](https://github.com/Ralim/IronOS/issues/new/choose) using github account\*.
And if you would like to:
- ask more generic question about IronOS/supported hardware/something you're curious about/etc.
- reach out community to chat with
- share your soldering & DIY skills
- share some interesting finding
- share useful related hardware/software with others
or _anything_ like that, then you can use forum-like [Discussions here](https://github.com/Ralim/IronOS/discussions).
[^gh]: You may need to create it first if you don't have one - it's free of charge.
\*: You may need to create it first if you don't have one - it's free of charge.