From c0a946cbcb4bbe4be2869412e02044b2cff570ff Mon Sep 17 00:00:00 2001 From: Banjo Fox Date: Thu, 21 Jun 2018 11:24:50 -0400 Subject: [PATCH 1/3] Adding "Linux" Adding a Linux heading as that will cover most other installations. Although it should be noted that the Prerequisite Installation it references will also include MS Windows --- DEVELOPMENT.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 391f3a72..fbd9db8c 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -6,6 +6,10 @@ All commands are run in the Mac Terminal or terminal emulator of your choice, such as iTerm2. First, you will need [Git](https://git-scm.com/download/mac), [Homebrew](https://brew.sh/), [Rust](https://www.rust-lang.org/en-US/), and [Postgres](https://www.postgresql.org/). Follow the instructions to install Homebrew before continuing if you don't already have it. +### Linux + +Similar to Mac OSX all commands should be run from a terminal (a.k.a command line). First, you will need [Git](https://git-scm.com/download/mac), [Rust](https://www.rust-lang.org/en-US/), and [Postgres](https://www.postgresql.org/). Step-by-step instructions are also available here: [Installing Prerequisites](No Such URL yet) + #### Download the Repository Navigate to the directory on your machine where you would like to install the repository, such as in `~/dev` by running `cd dev`. Now, clone the remote repository by running `git clone https://github.com/Plume-org/Plume.git`. This will install the codebase to the `Plume` subdirectory. Navigate into that directory by running `cd Plume`. From 08f02f47bd25203f66f9f9882f3114746a914d5f Mon Sep 17 00:00:00 2001 From: Banjo Fox Date: Thu, 21 Jun 2018 11:30:03 -0400 Subject: [PATCH 2/3] Create PREREQUISITES.md --- doc/PREREQUISITES.md | 85 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 doc/PREREQUISITES.md diff --git a/doc/PREREQUISITES.md b/doc/PREREQUISITES.md new file mode 100644 index 00000000..5d0b874c --- /dev/null +++ b/doc/PREREQUISITES.md @@ -0,0 +1,85 @@ +# Installing Software Prerequisites + +These instructions have been adapted from the Aardwolf documentation, and may not be accurate. +As such, this notification should be updated once verified for Plume installs. + +> NOTE: These instructions may help in installing a production version, but are +intended for developers to be able to build and test their changes. If in doubt, +seek out documentation from your distribution package or from [the `doc` folder](doc). + +## Installing Requirements + +### Installing PostgreSQL +In order to run the Aardwolf backend, you will need to have access to a +[PostgreSQL](https://www.postgresql.org/) database. There are a few options for doing this, but for +this guide we’re going to assume you are running the database on your +development machine. + +#### Linux/OSX Instructions + +If you're on an Ubuntu-like machine, you should be able to install +PostgreSQL like this: + + $ sudo apt-get update + $ sudo apt-get install postgresql postgresql-contrib + +If you see an error like: + + = note: /usr/bin/ld: cannot find -lpq + collect2: error: ld returned 1 exit statusb + +Then you may need to install the libpq (PostgreSQL C-library) package as well : + + $ sudo apt-get install libpq-dev + +If you're on OSX and using `brew`, do + + $ brew update + $ brew install postgres + +For Gentoo (eselect-postgresql is optional), + + # emerge --sync + # emerge -av postgresql eselect-postgresql + +For Fedora/CentOS/RHEL, do + + # dnf install postgresql-server postgresql-contrib + +#### Windows Instructions + +For Windows, just download the installer [here](https://www.enterprisedb.com/downloads/postgres-postgresql-downloads#windows) and run it. After installing, make sure to add the /lib directory to your PATH system variable. + +### Installing rustup + +> Note: Rustup managed installations do appear to co-exist with system + installations on Gentoo, and should work on most other distributions. + If not, please file an issue with the Rust and Rustup teams or your distribution’s + managers. + +Next, you’ll need to have the [Rust](https://rust-lang.org/) toolchain +installed. The best way to do this is to install +[rustup](https://rustup.rs), which is a Rust toolchain manager. + +#### Linux/OSX Instructions + +Open your terminal and run the following command: + + $ curl https://sh.rustup.rs -sSf | sh + +For those who are (understandably) uncomfortable with piping a shell +script from the internet directly into `sh`, you can also +[use an alternate installation method](https://github.com/rust-lang-nursery/rustup.rs/#other-installation-methods). + +#### Windows Instructions + +If you don't already have them, download and install the [Visual C++ 2015 Build Tools](http://landinghub.visualstudio.com/visual-cpp-build-tools). + +Then, download the [rustup installer](https://www.rust-lang.org/en-US/install.html) and run it. That's it! + +### Installing Rust Toolchain + +Once you have `rustup` installed, make sure you have the `nightly` rust +toolchain installed: + + $ rustup toolchain install nightly From 8efabca55302f6f3c707065e362cfd60468442ba Mon Sep 17 00:00:00 2001 From: Banjo Fox Date: Thu, 21 Jun 2018 11:32:11 -0400 Subject: [PATCH 3/3] Adding link for PREREQUISITES.md --- DEVELOPMENT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index fbd9db8c..8b9773b2 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -8,7 +8,7 @@ All commands are run in the Mac Terminal or terminal emulator of your choice, su ### Linux -Similar to Mac OSX all commands should be run from a terminal (a.k.a command line). First, you will need [Git](https://git-scm.com/download/mac), [Rust](https://www.rust-lang.org/en-US/), and [Postgres](https://www.postgresql.org/). Step-by-step instructions are also available here: [Installing Prerequisites](No Such URL yet) +Similar to Mac OSX all commands should be run from a terminal (a.k.a command line). First, you will need [Git](https://git-scm.com/download/mac), [Rust](https://www.rust-lang.org/en-US/), and [Postgres](https://www.postgresql.org/). Step-by-step instructions are also available here: [Installing Prerequisites](/doc/PREREQUISITES.md) #### Download the Repository