aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1518082
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# base16-musikcube
+
+<!-- markdownlint-disable MD013 -->
+
+This repo provides templates for using [Base16](https://github.com/tinted-theming/home) color schemes with [musikcube](https://github.com/clangen/musikcube), a cross-platform, terminal-based music player, audio engine, metadata indexer, and server.
+
+All files in `colors` directory generated by [tinted-builder-rust](https://github.com/tinted-theming/tinted-builder-rust?tab=readme-ov-file).
+
+## Examples
+
+### base16-onedark
+
+![Example musikcube with base16-onedark colorscheme](./examples/img/onedark.png)
+
+### base16-google-light
+
+![Example musikcube with base16-google-light colorscheme](./examples/img/google-light.png)
+
+## Usage
+
+You can find an example scheme in `examples/theme.json`.
+
+Place this file in `$XDG_CONFIG_HOME/musikcube/themes`.
+
+## License
+
+MIT