aboutsummaryrefslogtreecommitdiffhomepage
path: root/Documentation/GettingStarted.md
diff options
context:
space:
mode:
authorBen V. Brown <[email protected]>2021-03-24 21:46:33 +1100
committerBen V. Brown <[email protected]>2021-03-24 21:46:33 +1100
commitf2dfe9318f934f15f78506cc7bf0f4e2cb01828e (patch)
tree8ea6be98a2e93b4d189521fb07ffc25d556d0e51 /Documentation/GettingStarted.md
parentb2c65e6a0ebc218b2213c018ecc6e505b9b44f11 (diff)
downloadIronOS-f2dfe9318f934f15f78506cc7bf0f4e2cb01828e.tar.gz
IronOS-f2dfe9318f934f15f78506cc7bf0f4e2cb01828e.zip
Spelling pass
Diffstat (limited to 'Documentation/GettingStarted.md')
-rw-r--r--Documentation/GettingStarted.md32
1 files changed, 16 insertions, 16 deletions
diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md
index 4d492b12..d80b0c77 100644
--- a/Documentation/GettingStarted.md
+++ b/Documentation/GettingStarted.md
@@ -22,19 +22,19 @@ The soldering iron symbol on the screen will appear near the tip. This is here t
And naturally, the spanner like icon represents that pressing the button near the rear of the soldering iron will enter the settings menu.
-In the settings you can turn on an advanted idle screen instead. The buttons still function the same, however, the image will be swapped for text telling you the current status of the iron with extra details.
+In the settings, you can turn on an advanced idle screen instead. The buttons still function the same, however, the image will be swapped for a text telling you the current status of the iron with extra details.
-Depending on how your device is being powered, at one end of the screen, the firmware will either draw text to show you the current voltage your unit is being provided with, a battery icon (if battery mode is enabled) or a power plug icon.
+Depending on how your device is being powered, at one end of the screen, the firmware will either draw text to show you the current-voltage your unit is being provided with, a battery icon (if battery mode is enabled) or a power plug icon.
-If you see exclamation marks (!!!) where the solderion icon should be, this indicates that the firmware can't see the tip connected. This could indicate a problem with the iron or tip if there is one inserted. First try removing and reinstalling the tip. If the issue persists please see the [hardware issues section](Documentation/HardwareIssues.md).
+If you see exclamation marks (!!!) where the soldering iron should be, this indicates that the firmware can't see the tip connected. This could indicate a problem with the iron or tip if there is one inserted. First, try removing and reinstalling the tip. If the issue persists please see the [hardware issues section](Documentation/HardwareIssues.md).
-This screen features a burn-in protection feature, where if no buttons or movement have been detected for a while it will automatically blank the screen to try and reduce burn in if the iron is left unattended. Any movement or button press will wake the screen.
+This screen features a burn-in protection feature, where if no buttons or movement have been detected for a while it will automatically blank the screen to try and reduce burn-in if the iron is left unattended. Any movement or button press will wake the screen.
### Hidden Extras
Additionally to the two icons shown, there are two "hidden" actions that can be performed on this menu.
-If you press and hold on the button near the tip of the soldering iron, this will bring up the temperature adjustment screen. Normally this is not required; but if you would like to adjust the set temperature _before_ the tip starts to heat, this can be useful.
+If you press and hold on to the button near the tip of the soldering iron, this will bring up the temperature adjustment screen. Normally this is not required; but if you would like to adjust the set temperature _before_ the tip starts to heat, this can be useful.
If you press and hold the button near the rear of the iron it will take you into the [debug menu](Documentation/DebugMenu.md).
@@ -46,15 +46,15 @@ The firmware defaults to 320C as the set point for the soldering mode, however o
Pressing and holding the button near the tip will enter **boost** mode. This allows temporarily overriding the set temperature to a higher (or lower) value. This can be useful as a way to force the tip to a higher temperature to drive more wattage into a large joint when the thermal connection is not ideal.
-Pressing and holding the rear button will exit soldering mode and land you back at the home screen. You can also do this by pressing both buttons at once and this will also work, this is a bit harder to do but is kept for compatibility to the Miniware firmware.
+Pressing and holding the rear button will exit soldering mode and land you back at the home screen. You can also do this by pressing both buttons at once and this will also work, this is a bit harder to do but is kept for compatibility with the Miniware firmware.
-Pressing and holding **both** buttons at once will enter locked mode, which will prevent the buttons doing anything. You can in the settings allow boost mode in locked mode optionally. This can be useful if you find yourself hitting the buttons and entering into the temperature adjustment screen by accident.
+Pressing and holding **both** buttons at once will enter locked mode, which will prevent the buttons from doing anything. You can in the settings allow boost mode in locked mode optionally. This can be useful if you find yourself hitting the buttons and entering into the temperature adjustment screen by accident.
### Idle sleep
-If the iron detects a period of time without any significant movement, it will enter into a sleep mode. This is indicated with a graphic one the screen similar to ZZzz (or text in detailed mode).
+If the iron detects a period of time without any significant movement, it will enter into a sleep mode. This is indicated with a graphic on the screen similar to ZZzz (or text in detailed mode).
-In this mode the temperature of the iron will automatically reduce down to a temperature just below the melting point of solder. This helps reduce the rate of oxidation and damage to the iron tip.
+In this mode, the temperature of the iron will automatically reduce down to a temperature just below the melting point of the solder. This helps reduce the rate of oxidation and damage to the iron tip.
Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up.
@@ -62,23 +62,23 @@ The Pinecil has a footprint (unpopulated) on the PCB for a hall effect sensor (S
### Idle shutdown
-If, after entering sleep mode the iron still does not see movement for a much longer time; it will shutdown and return to the home screen.
+If, after entering sleep mode the iron still does not see movement for a much longer time; it will shut down and return to the home screen.
## Settings Menu
-The settings menu is the most often evolving aspect of the firmware, so each option is not documented here. However, do not panic, as every menu option has a description so that you dont _need_ to come back here to figure them all out.
+The settings menu is the most often evolving aspect of the firmware, so each option is not documented here. However, do not panic, as every menu option has a description so that you don't _need_ to come back here to figure them all out.
-To navigate the menu, the two buttons act seperately.
+To navigate the menu, the two buttons act separately.
The button that you pressed to enter the menu (rear) cycles down the options, and the other button (front) will change the current option.
-To see a description of an option, just pause and wait and after a little bit it will scroll across the screen.
+To see a description of an option, just pause and wait and after a little bit, it will scroll across the screen.
-The menu is comprised of a "main menu" of categories and then sub items that allow you to adjust parameters.
+The menu is comprised of a "main menu" of categories and then sub-items that allows you to adjust parameters.
-You can long hold buttons to change through options faster, and there is some acceleration on when holding the buttons.
+You can long hold buttons to change through options faster, and there is some acceleration when holding the buttons.
There is a small scrollbar that will be shown along the edge of the screen to indicate how far through the current list you are.
Additionally, this scrollbar will blink rapidly when you are on the last item in a menu choice.
-I highly reccomend taking a few minutes to go through all of the options in the menu to get a feel for what you can change, almost every aspect of the internal system is adjustable to suit yourself.
+I highly recommend taking a few minutes to go through all of the options in the menu to get a feel for what you can change, almost every aspect of the internal system is adjustable to suit you.