Skip to content

Commit 5a1b2ec

Browse files
committed
Updated install instructions
1 parent d6859b2 commit 5a1b2ec

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
Install Rust according to https://www.rust-lang.org/tools/install.
44

5+
```bash
6+
git clone [email protected]:rage/tmc-langs-rust.git
7+
cd tmc-langs-rust
8+
cargo build
9+
```
10+
11+
If you have any troubles building the project, please do make an issue!
12+
13+
## Testing
14+
515
Install [zstd 1.5.2](https://github.com/facebook/zstd). For example, on Ubuntu you need the package `libzstd1`. For Windows, download the appropriate archive from the [releases](https://github.com/facebook/zstd/releases), extract it and add the extracted directory to your PATH.
616

717
Install [Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
@@ -12,19 +22,15 @@ Install [OpenJDK 11](https://openjdk.java.net/install/index.html) (other version
1222

1323
Install [.NET 6.0](https://dotnet.microsoft.com/download).
1424

15-
Install [check](https://libcheck.github.io/check/) (works with at least 0.14 and 0.15) and [valgrind](https://valgrind.org/).
25+
Install [check](https://libcheck.github.io/check/) (works with at least 0.14 and 0.15), [valgrind](https://valgrind.org/) and `libsubunit0` (or equivalent for your distribution).
1626

17-
Install [R](https://www.r-project.org/), [devtools](https://devtools.r-lib.org/) with `install.packages("devtools")` and [tmc-r-tester](https://github.com/testmycode/tmc-rstudio) with `devtools::install_github("testmycode/tmc-r-tester/tmcRtestrunner", build = FALSE)`.
27+
Install [R](https://www.r-project.org/), [devtools](https://devtools.r-lib.org/) by running `install.packages("devtools")` in `R` and [tmc-r-tester](https://github.com/testmycode/tmc-rstudio) by running `devtools::install_github("testmycode/tmc-r-tester/tmcRtestrunner", build = FALSE)` in `R`. `devtools` has several dependencies that need to be installed. For Ubuntu, they can be installed with
1828

1929
```bash
20-
git clone [email protected]:rage/tmc-langs-rust.git
21-
cd tmc-langs-rust
22-
cargo build
30+
sudo apt install libcurl-dev libxml2-dev libopenssl-dev gcc-c++ libharfbuzz-dev libfribidi-dev libfreetype6-dev libpng-dev libtiff5-dev libjpeg-dev
2331
```
2432

25-
If you have any troubles building the project, please do make an issue!
26-
27-
## Testing
33+
With the dependencies instaled, the tests can be run with
2834

2935
```bash
3036
cargo test

0 commit comments

Comments
 (0)