3d0d55c8d8
* `Default` app * add zed settings * add justfile * flake: update devShell, ignore tests, add `just` * update README * gh actions: lint, format, tests. build
59 lines
917 B
Markdown
59 lines
917 B
Markdown
# tim:r
|
|
|
|
## Build from source
|
|
|
|
### Requirements
|
|
|
|
#### Nix (recommend)
|
|
|
|
`cd` into root directory.
|
|
|
|
If `direnv` is installed, run `direnv allow` once to install dependencies. Others run `nix develop`.
|
|
|
|
|
|
#### Non Nix user
|
|
|
|
- [`Rust`](https://www.rust-lang.org/learn/get-started)
|
|
- [`Clippy`](https://github.com/rust-lang/rust-clippy)
|
|
- [`rustfmt`](https://github.com/rust-lang/rustfmt)
|
|
- [`just`](https://just.systems)
|
|
|
|
|
|
#### Run
|
|
|
|
```sh
|
|
cargo run
|
|
```
|
|
|
|
|
|
#### Build
|
|
|
|
- Linux
|
|
```sh
|
|
nix build
|
|
```
|
|
|
|
- Windows (cross-compilation)
|
|
```sh
|
|
nix build .#windows
|
|
```
|
|
|
|
#### Commands to `run`, `build` etc.
|
|
|
|
```sh
|
|
just --list
|
|
|
|
Available recipes:
|
|
build # build app
|
|
b # alias for `build`
|
|
default
|
|
format # format files
|
|
f # alias for `format`
|
|
lint # lint
|
|
l # alias for `lint`
|
|
run # run app
|
|
r # alias for `run`
|
|
test # run tests
|
|
t # alias for `test`
|
|
```
|