Vectornaut/dyna3
1
0
Fork 0
forked from StudioInfinity/dyna3
Code Pull requests Activity

Switch README step notes from italic to roman

Browse source
This commit is contained in:
Aaron Fenyes 2025-08-08 12:36:48 -07:00
parent 737e725290
commit f979e2cbb3
1 changed files with 19 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -25,37 +25,37 @@ The latest prototype is in the folder `app-proto`. It includes both a user inter
### Install the prerequisites ### Install the prerequisites
1. Install [`rustup`](https://rust-lang.github.io/rustup/): the officially recommended Rust toolchain manager 1. Install [`rustup`](https://rust-lang.github.io/rustup/): the officially recommended Rust toolchain manager
- *It's available on Ubuntu as a [Snap](https://snapcraft.io/rustup)* - It's available on Ubuntu as a [Snap](https://snapcraft.io/rustup)
2. Call `rustup default stable` to "download the latest stable release of Rust and set it as your default toolchain" 2. Call `rustup default stable` to "download the latest stable release of Rust and set it as your default toolchain"
- *If you forget, the `rustup` [help system](https://github.com/rust-lang/rustup/blob/d9b3601c3feb2e88cf3f8ca4f7ab4fdad71441fd/src/errors.rs#L109-L112) will remind you* - If you forget, the `rustup` [help system](https://github.com/rust-lang/rustup/blob/d9b3601c3feb2e88cf3f8ca4f7ab4fdad71441fd/src/errors.rs#L109-L112) will remind you
3. Call `rustup target add wasm32-unknown-unknown` to add the [most generic 32-bit WebAssembly target](https://doc.rust-lang.org/nightly/rustc/platform-support/wasm32-unknown-unknown.html) 3. Call `rustup target add wasm32-unknown-unknown` to add the [most generic 32-bit WebAssembly target](https://doc.rust-lang.org/nightly/rustc/platform-support/wasm32-unknown-unknown.html)
4. Call `cargo install wasm-pack` to install the [WebAssembly toolchain](https://rustwasm.github.io/docs/wasm-pack/) 4. Call `cargo install wasm-pack` to install the [WebAssembly toolchain](https://rustwasm.github.io/docs/wasm-pack/)
5. Call `cargo install trunk` to install the [Trunk](https://trunkrs.dev/) web-build tool 5. Call `cargo install trunk` to install the [Trunk](https://trunkrs.dev/) web-build tool
6. Add the `.cargo/bin` folder in your home directory to your executable search path 6. Add the `.cargo/bin` folder in your home directory to your executable search path
- *This lets you call Trunk, and other tools installed by Cargo, without specifying their paths* - This lets you call Trunk, and other tools installed by Cargo, without specifying their paths
- *On POSIX systems, the search path is stored in the `PATH` environment variable* - On POSIX systems, the search path is stored in the `PATH` environment variable
### Play with the prototype ### Play with the prototype
1. From the `app-proto` folder, call `trunk serve --release` to build and serve the prototype 1. From the `app-proto` folder, call `trunk serve --release` to build and serve the prototype
- *The crates the prototype depends on will be downloaded and served automatically* - The crates the prototype depends on will be downloaded and served automatically
- *For a faster build, at the expense of a much slower prototype, you can call `trunk serve` without the `--release` flag* - For a faster build, at the expense of a much slower prototype, you can call `trunk serve` without the `--release` flag
- *If you want to stay in the top-level folder, you can call `trunk serve --config app-proto [--release]`* from there instead. - If you want to stay in the top-level folder, you can call `trunk serve --config app-proto [--release]` from there instead.
3. In a web browser, visit one of the URLs listed under the message `INFO 📡 server listening at:` 3. In a web browser, visit one of the URLs listed under the message `INFO 📡 server listening at:`
- *Touching any file in the `app-proto` folder will make Trunk rebuild and live-reload the prototype* - Touching any file in the `app-proto` folder will make Trunk rebuild and live-reload the prototype
4. Press *ctrl+C* in the shell where Trunk is running to stop serving the prototype 4. Press *ctrl+C* in the shell where Trunk is running to stop serving the prototype
### Run the engine on some example problems ### Run the engine on some example problems
1. Use `sh` to run the script `tools/run-examples.sh` 1. Use `sh` to run the script `tools/run-examples.sh`
- *The script is location-independent, so you can do this from anywhere in the dyna3 repository* - The script is location-independent, so you can do this from anywhere in the dyna3 repository
- *The call from the top level of the repository is:* - The call from the top level of the repository is:
```bash ```bash
sh tools/run-examples.sh sh tools/run-examples.sh
``` ```
- *For each example problem, the engine will print the value of the loss function at each optimization step* - For each example problem, the engine will print the value of the loss function at each optimization step
- *The first example that prints is the same as the Irisawa hexlet example from the Julia version of the engine prototype. If you go into `engine-proto/gram-test`, launch Julia, and then* - The first example that prints is the same as the Irisawa hexlet example from the Julia version of the engine prototype. If you go into `engine-proto/gram-test`, launch Julia, and then
```julia ```julia
include("irisawa-hexlet.jl") include("irisawa-hexlet.jl")
@ -64,7 +64,7 @@ The latest prototype is in the folder `app-proto`. It includes both a user inter
end end
``` ```
*you should see that it prints basically the same loss history until the last few steps, when the lower default precision of the Rust engine really starts to show* you should see that it prints basically the same loss history until the last few steps, when the lower default precision of the Rust engine really starts to show
### Run the automated tests ### Run the automated tests
@ -74,14 +74,14 @@ The latest prototype is in the folder `app-proto`. It includes both a user inter
### Deploy the prototype ### Deploy the prototype
1. From the `app-proto` folder, call `trunk build --release` 1. From the `app-proto` folder, call `trunk build --release`
- *Building in [release mode](https://doc.rust-lang.org/cargo/reference/profiles.html#release) produces an executable which is smaller and often much faster, but harder to debug and more time-consuming to build* - Building in [release mode](https://doc.rust-lang.org/cargo/reference/profiles.html#release) produces an executable which is smaller and often much faster, but harder to debug and more time-consuming to build
- *If you want to stay in the top-level folder, you can call `trunk serve --config app-proto --release` from there instead* - If you want to stay in the top-level folder, you can call `trunk serve --config app-proto --release` from there instead
2. Use `sh` to run the packaging script `tools/package-for-deployment.sh`. 2. Use `sh` to run the packaging script `tools/package-for-deployment.sh`.
- *The script is location-independent, so you can do this from anywhere in the dyna3 repository* - The script is location-independent, so you can do this from anywhere in the dyna3 repository
- *The call from the top level of the repository is:* - The call from the top level of the repository is:
```bash ```bash
sh tools/package-for-deployment.sh sh tools/package-for-deployment.sh
``` ```
- *This will overwrite or replace the files in `deploy/dyna3`* - This will overwrite or replace the files in `deploy/dyna3`
3. Put the contents of `deploy/dyna3` in the folder on your server that the prototype will be served from. 3. Put the contents of `deploy/dyna3` in the folder on your server that the prototype will be served from.
- *To simplify uploading, you might want to combine these files into an archive called `deploy/dyna3.zip`. Git has been set to ignore this path* - To simplify uploading, you might want to combine these files into an archive called `deploy/dyna3.zip`. Git has been set to ignore this path