README.md

changeset 80
24e470b278e4
parent 74
df92e78cc3f4
equal deleted inserted replaced
79:b6af27f72492 80:24e470b278e4
18 18
19 ### Installing dependencies 19 ### Installing dependencies
20 20
21 Most dependencies are managed by the Cargo build system of [Rust]. You will 21 Most dependencies are managed by the Cargo build system of [Rust]. You will
22 only need to install the “nightly” Rust compiler and the 22 only need to install the “nightly” Rust compiler and the
23 [GNU Scientific Library] manually. At the time of writing this README, 23 [GNU Scientific Library] manually.
24 [alg_tools] also needs to be downloaded separately.
25 24
26 1. Install the [Rust] infrastructure (including Cargo) with [rustup]. 25 1. Install the [Rust] infrastructure (including Cargo) with [rustup].
27 2. Install a “nightly” release of the Rust compiler. With rustup, installed in 26 2. Install a “nightly” release of the Rust compiler. With rustup, installed in
28 the previous step, this can be done with 27 the previous step, this can be done with
29 28
36 35
37 For other operating systems, suggestions are available in the [rust-GSL] 36 For other operating systems, suggestions are available in the [rust-GSL]
38 crate documentation. If not correctly installed, you may need to pass 37 crate documentation. If not correctly installed, you may need to pass
39 extra `RUSTFLAGS` options to Cargo in the following steps to locate the 38 extra `RUSTFLAGS` options to Cargo in the following steps to locate the
40 library. 39 library.
41
42 4. Download [alg_tools] and unpack it under the same directory as this
43 package.
44 40
45 [rustup]: https://rustup.rs 41 [rustup]: https://rustup.rs
46 [alg_tools]: https://tuomov.iki.fi/software/alg_tools/ 42 [alg_tools]: https://tuomov.iki.fi/software/alg_tools/
47 [Rust]: https://www.rust-lang.org/ 43 [Rust]: https://www.rust-lang.org/
48 [GNU Scientific Library]: https://www.gnu.org/software/gsl/ 44 [GNU Scientific Library]: https://www.gnu.org/software/gsl/
88 84
89 The `cargo-d` script ensures that KaTeX mathematics is rendered in the 85 The `cargo-d` script ensures that KaTeX mathematics is rendered in the
90 generated documentation through an ugly workaround. Unfortunately, 86 generated documentation through an ugly workaround. Unfortunately,
91 `rustdoc`, akin to Rust largely itself, is stuck in 80's 7-bit gringo ASCII 87 `rustdoc`, akin to Rust largely itself, is stuck in 80's 7-bit gringo ASCII
92 world, and does not support modern markdown features, such as mathematics. 88 world, and does not support modern markdown features, such as mathematics.
89
90 ## Source repository
91
92 A Mercurial repository is available; see
93 https://tuomov.iki.fi/software/pointsource_algs/.

mercurial