From a30ef2555f29121ffba493dbfba869cf4bf988e7 Mon Sep 17 00:00:00 2001 From: alban Date: Sat, 27 Jan 2024 15:57:50 +0100 Subject: [PATCH] fix: better README --- README.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3e80551..afe8933 100644 --- a/README.md +++ b/README.md @@ -4,22 +4,31 @@ Use this code as a basis and let the laser points be with you. -**Crash course** +## **Crash course** +#### 1. Clone the project +```rust +git clone https://git.interhacker.space/protonphoton/lj_templates_rust && cd lj_templates_rust ``` -$ git clone https://git.interhacker.space/protonphoton/lj_templates_rust && cd lj_templates_rust - -# Create a settings file, see the content for more details including redis server url -$ cp copyme.settings.toml settings.toml && $EDITOR settings.toml - -# Run the projet -$ cargo run - +##### 2. Create a settings file, see the content for more details including redis server url +```rust +cp copyme.settings.toml settings.toml && $EDITOR settings.toml ``` +##### 3. Edit the draw.rs to create your custom behavior +```rust +$EDITOR src/draw.rs +``` + +##### 4. Run the projet +```rust +cargo run +``` + + ## Associate projects **The LJ rust tracer projet and the nannou visualiser might be of help to simulate your project.** -Todo: make a full tutorial for that \ No newline at end of file +Todo: make a full tutorial for that