aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 17 insertions, 22 deletions
diff --git a/README.md b/README.md
index 4cfc8d6e4..8a6a253f0 100644
--- a/README.md
+++ b/README.md
@@ -147,6 +147,11 @@ invokes cmake commands as needed.
make release-static
+* **Optional**: build documentation in `doc/html` (omit `HAVE_DOT=YES` if `graphviz` is not installed):
+
+ HAVE_DOT=YES doxygen Doxyfile
+
+
#### On Windows:
Binaries for Windows are built on Windows using the MinGW toolchain within
@@ -159,13 +164,20 @@ application.
* Download and install the [MSYS2 installer](http://msys2.github.io), either the 64-bit or the 32-bit package, depending on your system.
* Open the MSYS shell via the `MSYS2 Shell` shortcut
-* Update the packages in your MSYS2 install:
+* Update the core packages in your MSYS2 install:
- pacman -Sy
- pacman -Su --ignoregroup base
- pacman -Su
+ update-core
+
+* Exit the MSYS shell using Alt+F4, then restart MSYS and update packages using pacman:
+
+ pacman -Syuu
+
+* Exit the MSYS shell using Alt+F4
+* Edit the properties for the `MSYS2 Shell` shortcut changing "msys2_shell.bat" to "msys2_shell.cmd -mingw64" for 64-bit builds or "msys2_shell.cmd -mingw32" for 32-bit builds
+* Restart MSYS shell via modified shortcut and update packages again using pacman:
+
+ pacman -Syuu
- For those of you already familiar with pacman, you can run the normal `pacman -Syu` to update, but you may get errors and need to restart MSYS2 if pacman's dependencies are updated.
* Install dependencies:
@@ -226,23 +238,6 @@ By default, in either dynamically or statically linked builds, binaries target t
* ```make release-static-win64``` builds binaries on 64-bit Windows portable across 64-bit Windows systems
* ```make release-static-win32``` builds binaries on 64-bit or 32-bit Windows portable across 32-bit Windows systems
-### Building Documentation
-
-Monero developer documentation uses Doxygen, and is currently a work-in-progress.
-
-Dependencies: Doxygen `>=1.8.0`, Graphviz `>=2.28` (optional).
-
-* To build the HTML documentation without diagrams, change
- to the root of the source code directory, and run
-
- doxygen Doxyfile
-
-* To build the HTML documentation with diagrams (Graphviz required):
-
- HAVE_DOT=YES doxygen Doxyfile
-
-* The output will be built in doc/html/
-
## Running monerod
The build places the binary in `bin/` sub-directory within the build directory