diff --git a/README.md b/README.md index 3311c4ec9..81d5d75da 100644 --- a/README.md +++ b/README.md @@ -187,6 +187,24 @@ Dependencies: Doxygen 1.8.0 or later, Graphviz 2.28 or later (optional). * If you have installed Graphviz, you can also generate in-doc diagrams by instead running `HAVE_DOT=YES doxygen Doxyfile` * The output will be built in doc/html/ +## Running bitmonerod + +The build places the binary in `bin/` sub-directory within the build directory +from which cmake was invoked (repository root by default). To run in +foreground: + + ./bin/bitmonerod + +To run in background: + + ./bin/bitmonerod --log-file bitmonerod.log --detach + +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`. + ## Internationalization See README.i18n