diff --git a/README.md b/README.md index 7850ac8..2a27f9d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,16 @@ # Development -## Run client in web +## Prerequisites + +- Install [rust](https://rust-lang.org/tools/install/) +- Install [dioxus](https://dioxuslabs.com/learn/0.7/getting_started/#install-the-dioxus-cli) + + +## Run client in web ``` bash cd client -dx serve --platform web --features web +dx serve --platform web ``` ## Run client in desktop @@ -13,13 +19,13 @@ dx serve --platform web --features web cd client dx serve --platform desktop --features desktop ``` -or simply +or simply ``` bash cd client dx serve ``` -## Run the server +## Run the server ``` cd server @@ -29,22 +35,22 @@ cargo run ## Roadmap - Server channels and client UI url selection - - fallback to local state + - fallback to local state - Estimations & progress rollup - Disable/Enable branches - Show/Hide branches - Postgres persistance on the server -- Better interactions - - Reorder nodes +- Better interactions + - Reorder nodes - Side indicator correctness -- Optional local save & load -- ithoughtsx format import +- Optional local save & load +- ithoughtsx format import - Incremental state updates with state vectors - Writing some tests - Markdown export/import - Richtext node notes - mermaid & gfm -- Dealing with overlapping trees somehow? +- Dealing with overlapping trees somehow? - Add action buttons for keyboard shortcuts - Animations - Version snapshots (to create different annotations)