diff options
| author | Fuwn <[email protected]> | 2021-05-12 23:48:04 -0700 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2021-05-12 23:48:04 -0700 |
| commit | c7a282bd3f96c0e3cc0807aabd5b7104df6effc9 (patch) | |
| tree | 64818c0add5762ba1ae83c8d9e7aa7bdb605f6f2 /README.md | |
| download | lime-main.tar.xz lime-main.zip | |
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..556b26b --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +<a href="https://github.com/fuwn/lime"> +<h1 align="center">🧶 lime</h1> +</a> +<p align="center"> +no bs url shortening +</p> +<p align="center"> +<img src="./assets/screenshot_index.png" alt="screenshot of index page"> +</p> + +## nix +- build: `nix-build` +- docker: `nix-build docker.nix` + +## usage (without docker) +- run (dev): `cargo run` + +## development dependencies +### required +- [diesel_cli](https://crates.io/crates/diesel_cli) +- [cargo-make](https://github.com/sagiegurari/cargo-make) + +### optional +- [cargo-watch](https://crates.io/crates/cargo-watch) + +*these development dependencies will automatically be satisfied if you are using the nix +shell configuration as provided.* + +### license +[gnu general public license v3.0](./license) |