rottenwheel/monero
1
0
Fork 0
mirror of https://codeberg.org/anoncontributorxmr/monero.git synced 2024-11-27 05:13:25 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

readme - explain building master vs. release

Browse Source 
Update readme to explain and warn about building master, and encourage (via example) to build release branches.  

Also updated instance where example build instructions had 0.11.0 as the most recent release.
This commit is contained in:
Gingeropolous 2018-06-05 08:31:55 -04:00 committed by GitHub
parent 8a7b3ff138
commit 2861289efd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -22,6 +22,10 @@ Portions Copyright (c) 2012-2013 The Cryptonote developers.
## Build ## Build
### IMPORTANT
These builds are of the master branch, which is used for active development and can be either unstable or incompatible with release software. Please compile release branches.
| Operating System | Processor | Status | | Operating System | Processor | Status |
| --------------------- | -------- |--------| | --------------------- | -------- |--------|
| Ubuntu 16.04 | i686 | [![Ubuntu 16.04 i686](https://build.getmonero.org/png?builder=monero-static-ubuntu-i686)](https://build.getmonero.org/builders/monero-static-ubuntu-i686) | Ubuntu 16.04 | i686 | [![Ubuntu 16.04 i686](https://build.getmonero.org/png?builder=monero-static-ubuntu-i686)](https://build.getmonero.org/builders/monero-static-ubuntu-i686)
@ -210,9 +214,10 @@ invokes cmake commands as needed.
#### On Linux and OS X #### On Linux and OS X
* Install the dependencies * Install the dependencies
* Change to the root of the source code directory and build: * Change to the root of the source code directory, change to the most recent release branch, and build:
cd monero cd monero
git checkout v0.12.2.0
make make
*Optional*: If your machine has several cores and enough memory, enable *Optional*: If your machine has several cores and enough memory, enable
@ -223,6 +228,12 @@ invokes cmake commands as needed.
*Note*: If cmake can not find zmq.hpp file on OS X, installing `zmq.hpp` from *Note*: If cmake can not find zmq.hpp file on OS X, installing `zmq.hpp` from
https://github.com/zeromq/cppzmq to `/usr/local/include` should fix that error. https://github.com/zeromq/cppzmq to `/usr/local/include` should fix that error.
*Note*: The instructions above will compile the most stable release of the
Monero software. If you would like to use and test the most recent software,
use ```git checkout master```. The master branch may contain updates that are
both unstable and incompatible with release software, though testing is always
encouraged.
* The resulting executables can be found in `build/release/bin` * The resulting executables can be found in `build/release/bin`
* Add `PATH="$PATH:$HOME/monero/build/release/bin"` to `.profile` * Add `PATH="$PATH:$HOME/monero/build/release/bin"` to `.profile`
@ -268,7 +279,7 @@ Tested on a Raspberry Pi Zero with a clean install of minimal Raspbian Stretch (
``` ```
git clone https://github.com/monero-project/monero.git git clone https://github.com/monero-project/monero.git
cd monero cd monero
git checkout tags/v0.11.1.0 git checkout tags/v0.12.2.0
``` ```
* Build: * Build:
``` ```