Mercurial > repos > non-riemannian-opt / file diff

--- a/README.md	Fri Dec 06 22:36:50 2024 -0500
+++ b/README.md	Sat Dec 07 14:08:27 2024 -0500
@@ -16,16 +16,12 @@
 ### Installing dependencies
 
 Most dependencies are managed by the Cargo build system of [Rust]. You will
-only need to manually install the “stable” Rust system itself. At the time
-of writing this README, [alg_tools] also needs to be downloaded separately.
+only need to manually install the “stable” Rust system itself.
+At the time of writing this README, [alg_tools] also needs to be downloaded
+separately.
 
 1.  Install the [Rust] infrastructure (including Cargo) with [rustup].
-2.  Install a “stable” release of the Rust compiler. With rustup, installed in
-    the previous step, this can be done with
-    ```console
-    rustup toolchain install stable
-    ```
-3. Download [alg_tools] and unpack it under the same directory as this
+2. Download [alg_tools] and unpack it under the same directory as this
    package.
 
   [rustup]: https://rustup.rs
@@ -37,19 +33,19 @@
 
 ### Building and running the experiments
 
-To compile the code and run the experiments in the manuscript, use
+To compile and install the program, use:
 ```console
-cargo run
+cargo install --path=.
 ```
 When doing this for the first time, several dependencies will be downloaded.
-
-Alternatively, you may build the executable with
+After this, you may run the experiment with
 ```console
-cargo build --release
+non-riemannian-opt
 ```
-and then run it with
-```
-target/release/non-riemannian-opt
+
+Alternatively, you may build (without installing) and run the experiments with
+```console
+cargo run --release
 ```
 
 ## Internals