Sfoglia il codice sorgente

README.md: Add compilation instructions

Johannes Hofmann 7 anni fa
parent
commit
2d3600907d
1 ha cambiato i file con 34 aggiunte e 1 eliminazioni
  1. 34
    1
      README.md

+ 34
- 1
README.md Vedi File

@@ -1,3 +1,36 @@
1
-deltamap
1
+DeltaMap
2 2
 ========
3 3
 A simple map viewer.
4
+
5
+Building
6
+--------
7
+DeltaMap is written in Rust, so you will need to [install
8
+Rust](https://www.rust-lang.org/install.html) to compile the program. The
9
+minimum supported version of Rust for DeltaMap is **1.25**.
10
+
11
+On Linux you will also need OpenSSL with headers.
12
+(see https://github.com/sfackler/rust-openssl for details)
13
+
14
+```sh
15
+# On Debian and Ubuntu
16
+$ sudo apt-get install pkg-config libssl-dev
17
+# On Arch Linux
18
+$ sudo pacman -S openssl
19
+# On Fedora
20
+$ sudo dnf install openssl-devel
21
+```
22
+
23
+Build and install the latest release from crates.io:
24
+
25
+```sh
26
+$ cargo install deltamap
27
+```
28
+
29
+Build the latest development version:
30
+
31
+```sh
32
+$ git clone https://github.com/b-r-u/deltamap
33
+$ cd deltamap
34
+$ cargo build --release
35
+$ ./target/release/deltamap
36
+```