nihilist/monero
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #5036

Browse Source 
d6dde478 remove trailing whitespace in README.md (David Meister)
This commit is contained in:
Riccardo Spagni 2019-01-16 21:41:09 +02:00
commit 7e172dc8b0
No known key found for this signature in database
GPG Key ID: 55432DF31CCD4FCD
2 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -31,7 +31,7 @@ Our researchers are available on IRC in [#monero-research-lab on Freenode](https
## Build ## Build
### IMPORTANT ### 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. 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.
@ -106,7 +106,7 @@ If you want to help out, see [CONTRIBUTING](CONTRIBUTING.md) for a set of guidel
## Scheduled software upgrades ## Scheduled software upgrades
Monero uses a fixed-schedule software upgrade (hard fork) mechanism to implement new features. This means that users of Monero (end users and service providers) should run current versions and upgrade their software on a regular schedule. Software upgrades occur during the months of April and October. The required software for these upgrades will be available prior to the scheduled date. Please check the repository prior to this date for the proper Monero software version. Below is the historical schedule and the projected schedule for the next upgrade. Monero uses a fixed-schedule software upgrade (hard fork) mechanism to implement new features. This means that users of Monero (end users and service providers) should run current versions and upgrade their software on a regular schedule. Software upgrades occur during the months of April and October. The required software for these upgrades will be available prior to the scheduled date. Please check the repository prior to this date for the proper Monero software version. Below is the historical schedule and the projected schedule for the next upgrade.
Dates are provided in the format YYYY-MM-DD. Dates are provided in the format YYYY-MM-DD.
| Software upgrade block height | Date | Fork version | Minimum Monero version | Recommended Monero version | Details | | Software upgrade block height | Date | Fork version | Minimum Monero version | Recommended Monero version | Details |
@ -125,7 +125,7 @@ X's indicate that these details have not been determined as of commit date.
## Release staging schedule and protocol ## Release staging schedule and protocol
Approximately three months prior to a scheduled software upgrade, a branch from Master will be created with the new release version tag. Pull requests that address bugs should then be made to both Master and the new release branch. Pull requests that require extensive review and testing (generally, optimizations and new features) should *not* be made to the release branch. Approximately three months prior to a scheduled software upgrade, a branch from Master will be created with the new release version tag. Pull requests that address bugs should then be made to both Master and the new release branch. Pull requests that require extensive review and testing (generally, optimizations and new features) should *not* be made to the release branch.
## Compiling Monero from source ## Compiling Monero from source
@ -200,12 +200,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 *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, 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 use ```git checkout master```. The master branch may contain updates that are
both unstable and incompatible with release software, though testing is always both unstable and incompatible with release software, though testing is always
encouraged. encouraged.
* The resulting executables can be found in `build/release/bin` * The resulting executables can be found in `build/release/bin`
@ -235,14 +235,14 @@ Dependencies need to be built with -fPIC. Static libraries usually aren't, so yo
#### On the Raspberry Pi #### On the Raspberry Pi
Tested on a Raspberry Pi Zero with a clean install of minimal Raspbian Stretch (2017-09-07 or later) from https://www.raspberrypi.org/downloads/raspbian/. If you are using Raspian Jessie, [please see note in the following section](#note-for-raspbian-jessie-users). Tested on a Raspberry Pi Zero with a clean install of minimal Raspbian Stretch (2017-09-07 or later) from https://www.raspberrypi.org/downloads/raspbian/. If you are using Raspian Jessie, [please see note in the following section](#note-for-raspbian-jessie-users).
* `apt-get update && apt-get upgrade` to install all of the latest software * `apt-get update && apt-get upgrade` to install all of the latest software
* Install the dependencies for Monero from the 'Debian' column in the table above. * Install the dependencies for Monero from the 'Debian' column in the table above.
* Increase the system swap size: * Increase the system swap size:
``` ```
sudo /etc/init.d/dphys-swapfile stop sudo /etc/init.d/dphys-swapfile stop
sudo nano /etc/dphys-swapfile sudo nano /etc/dphys-swapfile
CONF_SWAPSIZE=2048 CONF_SWAPSIZE=2048
@ -276,7 +276,7 @@ If you are using the older Raspbian Jessie image, compiling Monero is a bit more
* As before, `apt-get update && apt-get upgrade` to install all of the latest software, and increase the system swap size * As before, `apt-get update && apt-get upgrade` to install all of the latest software, and increase the system swap size
``` ```
sudo /etc/init.d/dphys-swapfile stop sudo /etc/init.d/dphys-swapfile stop
sudo nano /etc/dphys-swapfile sudo nano /etc/dphys-swapfile
CONF_SWAPSIZE=2048 CONF_SWAPSIZE=2048
@ -332,7 +332,7 @@ application.
pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake mingw-w64-x86_64-boost mingw-w64-x86_64-openssl mingw-w64-x86_64-zeromq mingw-w64-x86_64-libsodium mingw-w64-x86_64-hidapi pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake mingw-w64-x86_64-boost mingw-w64-x86_64-openssl mingw-w64-x86_64-zeromq mingw-w64-x86_64-libsodium mingw-w64-x86_64-hidapi
To build for 32-bit Windows: To build for 32-bit Windows:
pacman -S mingw-w64-i686-toolchain make mingw-w64-i686-cmake mingw-w64-i686-boost mingw-w64-i686-openssl mingw-w64-i686-zeromq mingw-w64-i686-libsodium mingw-w64-i686-hidapi pacman -S mingw-w64-i686-toolchain make mingw-w64-i686-cmake mingw-w64-i686-boost mingw-w64-i686-openssl mingw-w64-i686-zeromq mingw-w64-i686-libsodium mingw-w64-i686-hidapi
* Open the MingW shell via `MinGW-w64-Win64 Shell` shortcut on 64-bit Windows * Open the MingW shell via `MinGW-w64-Win64 Shell` shortcut on 64-bit Windows
@ -348,11 +348,11 @@ application.
**Building** **Building**
* Change to the cloned directory, run: * Change to the cloned directory, run:
cd monero cd monero
* If you would like a specific [version/tag](https://github.com/monero-project/monero/tags), do a git checkout for that version. eg. 'v0.13.0.0'. If you dont care about the version and just want binaries from master, skip this step: * If you would like a specific [version/tag](https://github.com/monero-project/monero/tags), do a git checkout for that version. eg. 'v0.13.0.0'. If you dont care about the version and just want binaries from master, skip this step:
git checkout v0.13.0.4 git checkout v0.13.0.4
* If you are on a 64-bit system, run: * If you are on a 64-bit system, run:
@ -368,7 +368,7 @@ application.
* **Optional**: to build Windows binaries suitable for debugging on a 64-bit system, run: * **Optional**: to build Windows binaries suitable for debugging on a 64-bit system, run:
make debug-static-win64 make debug-static-win64
* **Optional**: to build Windows binaries suitable for debugging on a 32-bit system, run: * **Optional**: to build Windows binaries suitable for debugging on a 32-bit system, run:
make debug-static-win32 make debug-static-win32
@ -417,7 +417,7 @@ mkdir ~/boost
cd ~/boost cd ~/boost
# Fetch boost source # Fetch boost source
ftp -o boost_1_64_0.tar.bz2 https://netcologne.dl.sourceforge.net/project/boost/boost/1.64.0/boost_1_64_0.tar.bz2 ftp -o boost_1_64_0.tar.bz2 https://netcologne.dl.sourceforge.net/project/boost/boost/1.64.0/boost_1_64_0.tar.bz2
# MUST output: (SHA256) boost_1_64_0.tar.bz2: OK # MUST output: (SHA256) boost_1_64_0.tar.bz2: OK
echo "7bcc5caace97baa948931d712ea5f37038dbb1c5d89b43ad4def4ed7cb683332 boost_1_64_0.tar.bz2" | sha256 -c echo "7bcc5caace97baa948931d712ea5f37038dbb1c5d89b43ad4def4ed7cb683332 boost_1_64_0.tar.bz2" | sha256 -c
@ -651,7 +651,7 @@ Run the build.
Once it stalls, enter the following command: Once it stalls, enter the following command:
``` ```
gdb /path/to/monerod `pidof monerod` gdb /path/to/monerod `pidof monerod`
``` ```
Type `thread apply all bt` within gdb in order to obtain the stack trace Type `thread apply all bt` within gdb in order to obtain the stack trace

4
tests/README.md
View File

@ -27,7 +27,7 @@ To run the same tests on a release build, replace `debug` with `release`.
# Crypto Tests # Crypto Tests
Crypto tests are located under the `tests/crypto` directory. Crypto tests are located under the `tests/crypto` directory.
- `crypto-tests.h` contains test harness headers - `crypto-tests.h` contains test harness headers
- `main.cpp` implements the driver for the crypto tests - `main.cpp` implements the driver for the crypto tests
@ -50,7 +50,7 @@ To run the same tests on a release build, replace `debug` with `release`.
# Functional tests # Functional tests
[TODO] [TODO]
Functional tests are located under the `tests/functional` directory. Functional tests are located under the `tests/functional` directory.
First, run a regtest daemon in the offline mode and with a fixed difficulty: First, run a regtest daemon in the offline mode and with a fixed difficulty:
``` ```