From 837baf57f8dd4084cb45842922c18bcfc509f6ed Mon Sep 17 00:00:00 2001 From: redfish Date: Sat, 20 Aug 2016 00:49:10 -0400 Subject: [PATCH 1/8] readme: clarify conf syntax re leading dashes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 14652d0eb..9fc5513ce 100644 --- a/README.md +++ b/README.md @@ -189,7 +189,7 @@ To list all available options, run `./bin/bitmonerod --help`. Options can be specified either on the command line or in a configuration file passed by the `--config-file` argument. To specify an option in the configuration file, add a line with the syntax `argumentname=value`, where `argumentname` is the name -of the argument without any dashes, for example `log-level=1`. +of the argument without the leading dashes, for example `log-level=1`. ## Internationalization From 556998643c23118962dee83bf0fc1b058b9ef886 Mon Sep 17 00:00:00 2001 From: redfish Date: Sat, 20 Aug 2016 01:00:41 -0400 Subject: [PATCH 2/8] readme: format dependencies into a list #951 --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9fc5513ce..21620a5ef 100644 --- a/README.md +++ b/README.md @@ -54,8 +54,21 @@ See [LICENSE](LICENSE). ### Overview: -Dependencies: GCC 4.7.3 or later, CMake 3.0.0 or later, libunbound 1.4.16 or later (note: Unbound is not a dependency, libunbound is), libevent 2.0 or later, libgtest 1.5 or later, and Boost 1.53 or later (except 1.54, [more details here](http://goo.gl/RrCFmA)), BerkeleyDB 4.8 or later (note: on Ubuntu this means installing libdb-dev and libdb++-dev). -Static Build Additional Dependencies: ldns 1.6.17 or later, expat 1.1 or later, bison or yacc +Dependencies: + +* GCC `>=4.7.3` +* CMake `>=3.0.0` +* libunbound `>=1.4.16` (note: Unbound is not a dependency, libunbound is) +* libevent `>=2.0` +* libgtest `>=1.5` +* Boost `>=1.53 && !=1.54` (note: 1.54 is not supported [more details here](http://goo.gl/RrCFmA)), +* BerkeleyDB `>=4.8` (note: on Ubuntu this means installing libdb-dev and libdb++-dev) + +Static Build Additional Dependencies: + +* ldns `>=1.6.17` +* expat `>=1.1` +* bison or yacc **Basic Process:** From a29b196eebe3f13ea58d9542691e8ea19dbc1caa Mon Sep 17 00:00:00 2001 From: redfish Date: Sat, 20 Aug 2016 01:22:12 -0400 Subject: [PATCH 3/8] readme: decrease size of sponsor logos --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 21620a5ef..0e01dc305 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,12 @@ The Bitcoin donation address is: 1KTexdemPdxSBcG55heUuTjDRYqbC5ZL8H Core development funding and/or some supporting services are also graciously provided by sponsors: -[![MyMonero](https://static.getmonero.org/images/sponsors/mymonero.png)](https://mymonero.com) [![Kitware](https://static.getmonero.org/images/sponsors/kitware.png?1)](http://kitware.com) [![Dome9](https://static.getmonero.org/images/sponsors/dome9.png)](http://dome9.com) [![Araxis](https://static.getmonero.org/images/sponsors/araxis.png)](http://araxis.com) [![JetBrains](https://static.getmonero.org/images/sponsors/jetbrains.png)](http://www.jetbrains.com/) [![Navicat](https://static.getmonero.org/images/sponsors/navicat.png)](http://www.navicat.com/) +[](https://mymonero.com) +[](http://kitware.com) +[](http://dome9.com) +[](http://araxis.com) +[](http://www.jetbrains.com/) +[](http://www.navicat.com/) There are also several mining pools that kindly donate a portion of their fees, [a list of them can be found on our Bitcointalk post](https://bitcointalk.org/index.php?topic=583449.0). From 2b8a1eb9cb0e89aa9d4fdb0ed879ec71741e6397 Mon Sep 17 00:00:00 2001 From: redfish Date: Sat, 20 Aug 2016 12:04:04 -0400 Subject: [PATCH 4/8] readme: add pkg-config dep --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0e01dc305..83dcf5593 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,7 @@ Dependencies: * GCC `>=4.7.3` * CMake `>=3.0.0` +* pkg-config * libunbound `>=1.4.16` (note: Unbound is not a dependency, libunbound is) * libevent `>=2.0` * libgtest `>=1.5` From 5018dfb79a6ef4fef3c45496dc2d10400ff83a5e Mon Sep 17 00:00:00 2001 From: redfish Date: Sat, 20 Aug 2016 12:11:07 -0400 Subject: [PATCH 5/8] readme: add deps: miniupnpc and libunwind miniupnpc is included in source repo, but list it anyway, eventually that fork will hopefully go away from this repo. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 83dcf5593..a607f350a 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,8 @@ Dependencies: * libgtest `>=1.5` * Boost `>=1.53 && !=1.54` (note: 1.54 is not supported [more details here](http://goo.gl/RrCFmA)), * BerkeleyDB `>=4.8` (note: on Ubuntu this means installing libdb-dev and libdb++-dev) +* libunwind (optional, for stack trace on exception) +* miniupnpc (optional, for NAT punching) Static Build Additional Dependencies: From d3363d573e02fc966846d247bf11287772733539 Mon Sep 17 00:00:00 2001 From: redfish Date: Sat, 20 Aug 2016 12:11:57 -0400 Subject: [PATCH 6/8] readme: add deps for documentation --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a607f350a..4d9f4430e 100644 --- a/README.md +++ b/README.md @@ -72,12 +72,17 @@ Dependencies: * libunwind (optional, for stack trace on exception) * miniupnpc (optional, for NAT punching) -Static Build Additional Dependencies: +Additional dependencies for statically-linked build: * ldns `>=1.6.17` * expat `>=1.1` * bison or yacc +Additional dependencies for building documentation: + +* Doxygen +* graphviz + **Basic Process:** * Install the dependencies (see below for more detailed instructions for your OS) From fcd895051a2684d3d6be82b98824bf2e356831f5 Mon Sep 17 00:00:00 2001 From: redfish Date: Sun, 21 Aug 2016 12:31:43 -0400 Subject: [PATCH 7/8] readme: formatting for rlwrap command snippet --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4d9f4430e..f4c9e7e43 100644 --- a/README.md +++ b/README.md @@ -237,6 +237,10 @@ TAILS ships with a very restrictive set of firewall rules. Therefore, you need t ## Using readline -While bitmonerod and simplewallet do not use readline directly, most of the functionality can be obtained by running them via rlwrap. This allows command recall, edit capabilities, etc. It does not give autocompletion without an extra completion file, however. To use rlwrap, simply prepend "rlwrap " to the command line, eg: -rlwrap bin/simplewallet --wallet-file /path/to/wallet +While bitmonerod and simplewallet do not use readline directly, most of the +functionality can be obtained by running them via rlwrap. This allows command +recall, edit capabilities, etc. It does not give autocompletion without an +extra completion file, however. To use rlwrap, prefix the command with +`rlwrap`: + rlwrap bin/simplewallet --wallet-file /path/to/wallet From 23accbcca5558854f237705bbe9ee8043df3ea4a Mon Sep 17 00:00:00 2001 From: redfish Date: Sun, 21 Aug 2016 12:34:38 -0400 Subject: [PATCH 8/8] readme: format Windows deps as a list --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f4c9e7e43..fba067b87 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,14 @@ Alternatively, it can be built in an easier and more automated fashion using Hom ### On Windows: -Dependencies: mingw-w64, msys2, CMake 3.0.0 or later, libunbound 1.4.16 or later (note: Unbound is not a dependency, libunbound is), and Boost 1.53 or 1.55 (except 1.54, [more details here](http://goo.gl/RrCFmA)), BerkeleyDB 4.8 or later (note: on Ubuntu this means installing libdb-dev and libdb++-dev). +Dependencies: + +* mingw-w64 +* msys2 +* CMake `>=3.0.0` +* libunbound `>=1.4.16` (note: Unbound is not a dependency, libunbound is) +* Boost 1.53 or 1.55 (except 1.54, [more details here](http://goo.gl/RrCFmA)) +* BerkeleyDB `>=4.8` **Preparing the Build Environment**