protonphoton
/
lj_templates_rust
6
0
Fork 1
Code Issues Pull Requests Releases Wiki Activity

fix: better README

This commit is contained in:
alban 2024-01-27 15:57:50 +01:00
parent cc9966bf73
commit a30ef2555f
1 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -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
Todo: make a full tutorial for that