aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 556b26b71b9222f1f84718b127c6368cc102ab1f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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)