From 2c33e1612db518a344c28f92acf6ab25b6fee980 Mon Sep 17 00:00:00 2001 From: Bat Date: Sun, 2 Sep 2018 12:13:17 +0100 Subject: [PATCH] Docs: add some details about installation --- docs/INSTALL.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 0e4aabd5..024b326d 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -4,10 +4,12 @@ In order to be installed and to work correctly, Plume needs: -- Git -- PostgreSQL -- GetText -- Rust and Cargo +- *Git* (to get the code) +- *Curl* (for RustUp, the Rust installer) +- *GCC* (to compile C dependencies) +- *PostgreSQL* (for the database) +- *GetText* (to manage translations) +- *Rust* and *Cargo* (to build the code) All the following instructions will need a terminal. @@ -66,6 +68,14 @@ You can install it on **GNU/Linux** and **Mac OS X** with: curl https://sh.rustup.rs -sSf | sh ``` +When asked, choose the *"1) Proceed with installation (default)"* option. + +Then run this command to be able to run cargo in the current session: + +```bash +export PATH="$PATH:/home/plume/.cargo/bin:/home/plume/.local/bin:/usr/local/sbin" +``` + On **Windows**, you'll need, if you don't already have them, to download and install the [Visual C++ 2015 Build Tools](https://www.microsoft.com/en-us/download/details.aspx?id=48159). Then, download the [rustup installer](https://www.rust-lang.org/en-US/install.html) and run it. ## Getting and compiling the Plume source code