summaryrefslogtreecommitdiffstats
path: root/docs/colorschemes.md
diff options
context:
space:
mode:
authorSean E. Russell <ser@ser1.net>2020-06-02 09:09:23 -0500
committerSean E. Russell <ser@ser1.net>2020-06-02 09:09:23 -0500
commitd6be10bcd88b45899fef9b66ead2ebf507743c39 (patch)
tree240f09c14a66274a9f4a856a70b15079b8219ccb /docs/colorschemes.md
parentdcec8a53b748efa0f5eae0124a343d47541cae63 (diff)
Closes #100, breaks up the README
Diffstat (limited to 'docs/colorschemes.md')
-rw-r--r--docs/colorschemes.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/colorschemes.md b/docs/colorschemes.md
new file mode 100644
index 0000000..430a372
--- /dev/null
+++ b/docs/colorschemes.md
@@ -0,0 +1,12 @@
+# Colorschemes
+
+gotop ships with a few colorschemes which can be set with the `-c` flag followed by the name of one. You can find all the colorschemes in the [colorschemes folder](./colorschemes).
+
+To make a custom colorscheme, check out the [template](./colorschemes/template.go) for instructions and then use [default.json](./colorschemes/default.json) as a starter. Then put the file at `~/.config/gotop/<name>.json` and load it with `gotop -c <name>`. Colorschemes PR's are welcome!
+
+To list all built-in color schemes, call:
+
+```
+gotop --list colorschemes
+```
+