aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorterminaldweller <thabogre@gmail.com>2022-07-12 13:51:32 +0000
committerterminaldweller <thabogre@gmail.com>2022-07-12 13:51:32 +0000
commit158d9d21208afe1e3420ab3e0bbd4852cdea5a58 (patch)
treed72745a8932517dcd7ad16096295003f32d85a58 /README.md
parentchanged the name of the src file (diff)
downloadcolo-158d9d21208afe1e3420ab3e0bbd4852cdea5a58.tar.gz
colo-158d9d21208afe1e3420ab3e0bbd4852cdea5a58.zip
added a README, fixed a typo, was printing hsl instead of hsi.
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/README.md b/README.md
index a7c051b..1e61425 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,25 @@
-# colo \ No newline at end of file
+# colo
+
+A simple script that prints out the 256 terminal colors in different formats:</br>
+It can print the numbers, the hex value, rgb,hsi and the ansi escape sequence.</br>
+
+```sh
+colo --help
+usage: colo [-h] [--ansi] [--hsi] [--rgb] [--number] [--name] [--hex]
+
+optional arguments:
+ -h, --help show this help message and exit
+ --ansi bool
+ --hsi bool
+ --rgb bool
+ --number bool
+ --name bool
+ --hex bool
+```
+
+![Image](./img/ansi.png)
+
+## How to get
+```sh
+pip3 install colo
+```