Remove generated file 'frontend.js'

[recipes.git] / README.md

diff --git a/README.md b/README.md
index 805d33c..cb02d2c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,53 @@
-== Autoreload
+# Use cases
+
+## Create a recipe
+
+To create a recipe the user must have an account.
+
+* The user
+(A group is automatically created)
+
+## Create a groupe
+
+## Move a group
+
+## Delete a group
+
+## Create a step
+
+## Move a step
+
+## Delete a step
+
+# Technical
+
+## Cross-compilation on Windows 11
+
+The toolchain for Raspberry Pi 64 bits is available here: https://gnutoolchains.com/raspberry64/
+
+## How to install service on RPI Zero
+
+1. Copy doc/recipes.service to /lib/systemd/system
+2. Enabled it: #> systemctl enable recipes
+
+## Backend
+
+Autoreload: https://actix.rs/docs/autoreload/
+
+### Frontend
+
+## WebAssembly
+
+'frontend' project needs some tools to generate the WebAssembly stuff. Everything is explained here: https://rustwasm.github.io/wasm-bindgen/examples/hello-world.html
+
+To compile run 'wasm-pack build' in 'frontend' directory
+To launch node run 'npm run start' in 'frontend/www' directory
+
+## Useful URLs
+
+* Rust patterns : https://github.com/rust-unofficial/patterns/tree/master/patterns
+* Rusqlite (SQLite) : https://docs.rs/rusqlite/0.20.0/rusqlite/
+* Node install: https://nodejs.org/en/download/
+
+
 
-https://actix.rs/docs/autoreload/
\ No newline at end of file