diff --git a/Logo-Editor.md b/Logo-Editor.md index 5c7a0ea..4047290 100644 --- a/Logo-Editor.md +++ b/Logo-Editor.md @@ -6,9 +6,9 @@ To bring back the logo support without having to code a smaller version of the U ## Existing Designs -In the repository there are some community created logos that you are free to use. As well as a logo file to remove the logo from your unit, turning off the logo functionality.[Available Here](https://github.com/Ralim/ts100/tree/master/Bootup%20Logo/Logos) +In the repository there are some community created logos that you are free to use. As well as a logo file to remove the logo from your unit, turning off the logo functionality. [Available Here](https://github.com/Ralim/ts100/tree/master/Bootup%20Logo/Logos) -## The logo editor +## The Logo Editor This is a small application written in C# that allows you to load up an image, and it will convert the image to B&W and export a .HEX file. This file can then be programmed to your iron using the DFU mode, the same as upgrading your firmware. @@ -30,16 +30,7 @@ The logo editor should run under mono on Mac, similar to Linux. It does however need to be started in 32 bit mode : `mono --arch=32 TS100.Logo.Editor.exe` -I have Python 2.7.10 and had to install `pil`(actually Pillow, inspired by [this post](https://stackoverflow.com/a/20061019/6705343) on Stack Exchange): - -` sudo pip install Pillow` - -Then running the python file: - -`./img2ts100.py infile.png outfile.hex` - - -### Using the software +### Using the Software 1. On the [releases page](https://github.com/Ralim/ts100/releases) you will need to download the latest copy of the GUI Tool (*TS100.Logo.Editor.exe*). 2. Launch the TS100 Logo Editor, see above @@ -47,12 +38,24 @@ Then running the python file: 4. Colour images are okay, the software will convert them to B&W for you. 5. You can also invert colours if you would prefer. 6. Save the created file as a *.hex* file somewhere. -7. Connect your iron to your computer in DFU mode (same as you would to upgrade firmware). +7. Connect your iron to your computer in DFU mode (same as you would to upgrade firmware — hold A when connecting). 8. Drag the created .hex file for the logo onto the iron to update it with the file. 9. You should be good to go. 10. The image will stay through future updates, but if it ever won't I will put a large warning in the update download on the releases page. This will only occur if the firmware grows significantly larger than it currently is. +## The Python Logo Converter +The [Python script](https://github.com/Ralim/ts100/blob/master/Bootup%20Logo/python_logo_converter/img2ts100.py) converts an image passed into it on the command line to a HEX file to be uploaded to the iron in DFU mode (similar to the process described above). The image can be in color and any size, but it will be resized and converted to 1-bit color. However, it looks best if you create a 96x16 image in an image editor and color the pixels black or white manually. +The converter requires at least Python 3 and Pillow (if you don't have it, it will tell you to install PIL, which is an old version of the same thing). See [this page](https://stackoverflow.com/a/20061019/6705343) on StackOverflow about installing it. +What works can vary, but this command may work: +`python3 -m pip install Pillow` +Then, to convert an image: + +`python3 img2ts100.py infile.png outfile.hex` + +Upload the HEX file to the iron in DFU mode and, if the file's extension changes to .RDY, your custom splash screen should show up on startup. + +Run `python3 img2ts100.py --help` to see available options. \ No newline at end of file