diff options
| author | Simon <vesspa0330@gmail.com> | 2025-02-05 22:26:35 -0500 |
|---|---|---|
| committer | Simon <vesspa0330@gmail.com> | 2025-02-05 22:26:35 -0500 |
| commit | e213d742a312ca9f91f0db6140132f0a680746d4 (patch) | |
| tree | 0ef1bc0f68123139a98cd72eafb226321b8a9e01 /README.md | |
| parent | bd129f18a6caf47e04390cd9612075e465c6411f (diff) | |
updated to include installation instructions
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 25 insertions, 0 deletions
@@ -8,6 +8,31 @@ A robust CLI color conversion utility written in Python. - Lenient automatic input detection (can be overriden) - Bulk conversions to and from files +# Installation + +This program is available as a package on the AUR. + +## For manual installation on Unix operating systems (Linux+MacOS): +- Ensure that you have `python3` installed +- Clone/download and unzip this repo +- Navigate to the unzipped folder in your terminal and run the following commands (technically, only the first command is necessary to use the program): +``` +# install -m 755 -TD "color-converter.py" "/usr/bin/color-converter" +# install -m 644 -TD "README.md" "/usr/share/doc/color-converter/README.md" +# install -m 644 -TD "LICENSE" "usr/share/licenses/color-converter/LICENSE" +``` + +To uninstall, run these commands: +``` +# rm -f "/usr/bin/color-converter" +# rm -rf "/usr/share/doc/color-converter/" +# rm -rf "/usr/share/licenses/color-converter/" +``` + +## For manual installation on Windows +To be frank, I don't have a Windows manchine so I'm not exactly sure how you would get this set up as an "installed" command line program. If you don't want to run it as a Python program each time, maybe you could create a batch script to run the program, and put said script somewhere in your PATH. + + # Usage Simply supply one or more color codes in any of the supported formats as a string, and you will receive output of all supported format conversions. |