mirror of
https://github.com/zaphar/kitchen.git
synced 2025-07-21 19:29:49 -04:00
docs: cleanup readme
This commit is contained in:
parent
6bc9f2ea2e
commit
4ffb481634
@ -6,10 +6,6 @@ A web assembly experiment in Meal Planning and Shopping List management.
|
|||||||
|
|
||||||
Ensure you have rust installed with support for the web assembly target. You can see instructions here: [Rust wasm book](https://rustwasm.github.io/docs/book/game-of-life/setup.html).
|
Ensure you have rust installed with support for the web assembly target. You can see instructions here: [Rust wasm book](https://rustwasm.github.io/docs/book/game-of-life/setup.html).
|
||||||
|
|
||||||
You will also want to have trunk installed. You can see instructions for that here: [trunk](https://trunkrs.dev/)
|
|
||||||
|
|
||||||
Then obtain the source. We do not at this time publish kitchen on [crates.io](https://crates.io/).
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git clone https://github.com/zaphar/kitchen
|
git clone https://github.com/zaphar/kitchen
|
||||||
cd kitchen
|
cd kitchen
|
||||||
@ -23,7 +19,7 @@ make release
|
|||||||
|
|
||||||
# Hacking on kitchen
|
# Hacking on kitchen
|
||||||
|
|
||||||
If you want to hack on kitchen, then you may find it useful to use trunk in dev mode. The run script will run build the app and run trunk with it watching for changes and reloading on demand in your browser.
|
The run script will run build the app and run it for you.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
./run.sh
|
./run.sh
|
||||||
@ -37,4 +33,4 @@ If all of the above looks like too much work, and you already use the nix packag
|
|||||||
|
|
||||||
```sh
|
```sh
|
||||||
nix run github:zaphar/kitchen
|
nix run github:zaphar/kitchen
|
||||||
```
|
```
|
||||||
|
Loading…
x
Reference in New Issue
Block a user