README.md

changeset 56
3a784e6e475a
parent 50
39c5e6c7759d
equal deleted inserted replaced
55:19e2140ba458 56:3a784e6e475a
19 19
20 ### Installing dependencies 20 ### Installing dependencies
21 21
22 Most dependencies are managed by the Cargo build system of [Rust]. You will 22 Most dependencies are managed by the Cargo build system of [Rust]. You will
23 only need to install the “nightly” Rust compiler and the 23 only need to install the “nightly” Rust compiler and the
24 [GNU Scientific Library] manually. At the time of writing this README, 24 [GNU Scientific Library] manually.
25 [alg_tools] also needs to be downloaded separately.
26 25
27 1. Install the [Rust] infrastructure (including Cargo) with [rustup]. 26 1. Install the [Rust] infrastructure (including Cargo) with [rustup].
28 2. Install a “nightly” release of the Rust compiler. With rustup, installed in 27 2. Install a “nightly” release of the Rust compiler. With rustup, installed in
29 the previous step, this can be done with 28 the previous step, this can be done with
30 ```console 29 ```console
36 brew install gsl 35 brew install gsl
37 ``` 36 ```
38 For other operating systems, suggestions are available in the [rust-GSL] 37 For other operating systems, suggestions are available in the [rust-GSL]
39 crate documentation. You may need to pass extra `RUSTFLAGS` options to 38 crate documentation. You may need to pass extra `RUSTFLAGS` options to
40 Cargo in the following steps to locate the library. 39 Cargo in the following steps to locate the 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 The `cargo-d` script ensures that KaTeX mathematics is rendered in the 84 The `cargo-d` script ensures that KaTeX mathematics is rendered in the
89 generated documentation through an ugly workaround. Unfortunately, 85 generated documentation through an ugly workaround. Unfortunately,
90 `rustdoc`, akin to Rust largely itself, is stuck in 80's 7-bit gringo ASCII 86 `rustdoc`, akin to Rust largely itself, is stuck in 80's 7-bit gringo ASCII
91 world, and does not support modern markdown features, such as mathematics. 87 world, and does not support modern markdown features, such as mathematics.
92 88
89 ## Source repository
90
91 A Mercurial repository is available; see
92 https://tuomov.iki.fi/software/pointsource_algs/.

mercurial