add project

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b7a96b4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# base16-lazygit
+
+<!-- markdownlint-disable MD013 -->
+
+This repo provides templates for using [Base16](https://github.com/tinted-theming/home) color schemes with [lazygit](https://github.com/jesseduffield/lazygit), simple terminal UI for git commands.
+
+All files in `colors` directory generated by [lustache](https://luarocks.org/modules/olivine-labs/lustache) and [lustache-cli](https://github.com/djmattyg007/lustache-cli).
+
+## Examples
+
+### base16-onedark
+
+![Example lazygit with base16-onedark colorscheme](./examples/img/onedark.png)
+
+### base16-google-light
+
+![Example lazygit with base16-google-light colorscheme](./examples/img/google-light.png)
+
+## Usage
+
+You can find an example config in `examples/config.yml`.
+
+Place this file in:
+
+- Linux: `~/.config/lazygit/config.yml`.
+- MacOS: `~/Library/Application\ Support/lazygit/config.yml`.
+- Windows: `%LOCALAPPDATA%\lazygit\config.yml` (default location, but it will also be found in `%APPDATA%\lazygit\config.yml`.
+
+## License
+
+MIT