diff --git a/Documentation/DebugMenu.md b/Documentation/DebugMenu.md index cf13271ad6..6e622999a1 100644 --- a/Documentation/DebugMenu.md +++ b/Documentation/DebugMenu.md @@ -1,7 +1,7 @@ # Debugging Menu -In this firmware there is extra debugging information hidden under and extra menu. -This is accessed by holding the rear (B) button on the iron while its on the home screen. +In this firmware there is extra debugging information hidden under an extra menu. +This is accessed by holding the rear (B) button on the iron while it is on the home screen. This menu is meant to be simple, so it has no fancy GUI animations. diff --git a/Documentation/Development.md b/Documentation/Development.md index d4e8660821..b9f94b2e69 100644 --- a/Documentation/Development.md +++ b/Documentation/Development.md @@ -24,7 +24,7 @@ To update the language translation files & associated font map, execute the `mak ## Building Pinecil -I highly reccomend using the command line tools and using docker to run the compiler. -Its a bit more fussy on setup than the STM tooling and this is by far the easiest way. +I highly recommend using the command line tools and using docker to run the compiler. +It's a bit more fussy on setup than the STM tooling and this is by far the easiest way. If you _need_ an IDE I have used [Nuclei's IDE](https://nucleisys.com/download.php) And follow same idea as the STM Cube IDE notes above. diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index 07d6fc9927..e71ca2e0ef 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -11,7 +11,7 @@ Flash according to details below ### Bleeding edge / latest -For the _latest_ code, you will need to download the zip file from the artefacts page on the build for what you want. +For the _latest_ code, you will need to download the zip file from the artifacts page on the build for what you want. Head to the [Actions](https://github.com/Ralim/IronOS/actions) page and then select the run for the appropriate branch you would like. In general you probably want `master`. @@ -51,7 +51,7 @@ sgr1ff1n (Shane) commented in [issue 11](https://github.com/Ralim/ts100/issues/1 While in past there were reports of unreliable upgrades, the consensus in [issue 11](https://github.com/Ralim/ts100/issues/11) is that things work mostly as expected in Linux. -@awigen has contributed a script [flash_ts100_linux.sh](https://raw.githubusercontent.com/Ralim/ts100/master/Flashing/flash_ts100_linux.sh) that works on Ubuntu 16.04 as well as other distro's. +@awigen has contributed a script [flash_ts100_linux.sh](https://raw.githubusercontent.com/Ralim/ts100/master/Flashing/flash_ts100_linux.sh) that works on Ubuntu 16.04 as well as other distros. If you want to do it manually (or if the script does not work for some reason) the general procedure is the same as for Windows, the differences are in the way to mount the unit and copy the firmware. Remember that after flashing, the firmware filename will have changed to end in `.RDY` or `.ERR` or `.NOT` and only `.RDY` means the flashing was successful! @@ -66,7 +66,7 @@ Example, to be run as root, once the unit has been plugged in DFU mode and auto- ```bash FW=ts100.hex unset NAME -eval $(lsblk -P -p -d --output NAME,MODEL|grep "DFU Disk") +eval $(lsblk -P -p -d --output NAME,MODEL|grep "DFU[ _]Disk") [ -z ${NAME+x} ] && exit 1 # Could not find DFU device umount "$NAME" mkdir /tmp/mntdfu @@ -100,8 +100,8 @@ dfu-util -d 28e9:0189 -a 0 -D Pinecil_EN.bin -s 0x08000000:mass-erase:force ### Windows -For windows the easiest tool to use is the vendors gui tool from [here](http://www.gd32mcu.com/download/down/document_id/176/path_type/1) -Should the link break, its called "GD32 MCU Dfu Tool" and can be grabbed from http://www.gd32mcu.com/en/download/ +For windows the easiest tool to use is the vendors gui tool from [here](http://www.gd32mcu.com/download/down/document_id/176/path_type/1). +Should the link break, its called "GD32 MCU Dfu Tool" and can be grabbed from http://www.gd32mcu.com/en/download/. You will also need the matching drivers from [here](http://www.gd32mcu.com/download/down/document_id/244/path_type/1) installed if you have not used gigadevice parts before. These are called "GD32 Dfu Drivers" if the link breaks. @@ -109,7 +109,7 @@ These are called "GD32 Dfu Drivers" if the link breaks. #### [Miniware] The file is showing up with the extension `.ERR` -This can occur duing the programming process if any of the checks in the bootloader fail. This is often triggered by anti-virus software or using a non-windows host OS. +This can occur during the programming process if any of the checks in the bootloader fail. This is often triggered by anti-virus software or using a non-windows host OS. First, try just copying the file a second time. @@ -119,15 +119,15 @@ First, try just copying the file a second time. 4. Copy the same hex file again **DO NOT TRY AND DELETE THE OLD ONE** 5. The device will disconnect and reconnect again 6. The device _should_ now have the `.RDY` file -7. Your done. +7. You're done. -If this fails, if you are on Mac or Linux reading the wiki page about programming can help. There is also a very long issue thread going through all of the different attempts around this too. +If this fails and you are on Mac or Linux reading the wiki page about programming can help. There is also a very long issue thread going through all of the different attempts around this too. -If you are on windows, its often to try another computer (friends, work, partners etc). +If you are on windows, it's often best to try another computer (friends, work, partners etc). #### [Miniware] Device randomly disconnects or does not show up in DFU mode -First, check the USB cable your using has the data pins; test it on another device. There are a surprisingly large number of usb-micro cables that are power _only_. +First, check the USB cable you are using has the data pins; test it on another device. There are a surprisingly large number of usb-micro cables that are power _only_. Secondly, try other USB ports. Often different USB controllers will interact with the units differently due to design quirks in the miniware design. @@ -139,4 +139,4 @@ This will **NOT** show up as a USB storage drive, but instead show up using a st To change to dapboot based alternative bootloader, you need to flash the hex file from [here](https://github.com/eDesignOSS/ts100-bl-flasher/releases). `ts100-stockbl.hex` will reflash the stock bootloader, `ts100-dapboot.hex` will flash the new dapboot based usb bootloader. -Note that this is only reccomended for users who know what they doing. If you dont not understand how this works; please dont flash this. +Note that this is only recommended for users who know what they are doing. If you don't not understand how this works; please don't flash this. diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 7eff81790a..2899187a80 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -3,14 +3,14 @@ Getting started with Iron OS on your Pinecil/TS80/TS80P/TS100. If your device did not come with Iron OS already installed, or if you need to update to the latest version; please see the [Flashing Guide](/Documentation/Flashing.md). -Once your Iron has been flashed, one first power on it _may_ warn you about the system settings being reset. +Once your Iron has been flashed, on first power on it _may_ warn you about the system settings being reset. _Do not panic_; this is 100% completely normal. This is here to note to you that they have been reset to handle the internal structure changing. If you receive a warning about the accelerometer or USB-PD not being detected, please see [here](/Documentation/HardwareIssues.md). ## The Home screen (or idle screen) -This is the landing page of the firmware, from here you can choose to either go into the [settings menu](##-Settings-Menu) or go into [soldering mode](##-Soldering-Mode). +This is the landing page of the firmware, from here you can choose to either go into the [settings menu](#Settings-Menu) or go into [soldering mode](#Soldering-Mode). By default this will show a screen similar to the one below: diff --git a/Documentation/Menu.md b/Documentation/Menu.md index fa4c919dce..555b20f04a 100644 --- a/Documentation/Menu.md +++ b/Documentation/Menu.md @@ -17,7 +17,7 @@ Note that settings are not saved until you exit the menu. If you leave the unit alone (ie don't press any buttons) on a setting, after 3 seconds the screen will scroll a rough description of the setting. The menu is arranged so that the most often used settings are first. -With submenu's being selected to enter using the front button (as if you were going to change the setting). +With submenus being selected to enter using the front button (as if you were going to change the setting). Scrolling through the submenu will return you back to its entry location after you scroll through all of the options. ### Calibrating input voltage @@ -48,7 +48,7 @@ Some tips will have an offset on their readings, to calibrate this out perform t 6. The display will start to scroll a warning message to check that the tip is at ambient temperature! 7. Press the button near the tip of the iron to confirm 8. The display will go to "...." for a short period of time as the unit measures the tip temperature and the handle temperature and compares them -9. The display will then go back to *TMP CAL* and it will display a number, this is your offset number. You generally dont need it unless debugging issues +9. The display will then go back to *TMP CAL* and it will display a number, this is your offset number. You generally don't need it unless debugging issues 10. Calibration is done, just exit the settings menu as normal 11. You're done, enjoy your iron! diff --git a/Documentation/Power.md b/Documentation/Power.md index 6806f6d7f9..995145adf0 100644 --- a/Documentation/Power.md +++ b/Documentation/Power.md @@ -2,7 +2,7 @@ All of the irons are PWM controlled resistive heating elements. This means that the electronics in the handle can only turn the heating element on and off. -This *means* that the power proivded in the tip is 100% controlled by the supply voltage used. +This *means* that the power provided in the tip is 100% controlled by the supply voltage used. Both irons at their simplest are just a resistor connected to your power source via a switch.