Merge pull request #1048
533eafa
readme: make section on docs more concise (redfish)
This commit is contained in:
commit
5c8c1d1968
22
README.md
22
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
|
||||
|
@ -226,23 +231,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
|
||||
|
|
Loading…
Reference in New Issue