diff --git a/README.rst b/README.rst index e2ae7ab62a0..07d212cb5a5 100644 --- a/README.rst +++ b/README.rst @@ -141,26 +141,15 @@ The general synopsis is as follows: Configuration ==== -The ``--config`` flag points to a ``.yaml`` file that is responsible to configuring the logging & other important settings for the node. E.g. see the Byron mainnet configuration in this +The ``--config`` flag points to a ``.yaml`` (or a structurally equivalent ``.json``) file that is responsible to configuring the logging & other important settings for the node. E.g. see the Byron mainnet configuration in this `configuration.yaml `_. + Some of the more important settings are as follows: * ``Protocol: RealPBFT`` -- Protocol the node will execute * ``RequiresNetworkMagic``: RequiresNoMagic -- Used to distinguish between mainnet (``RequiresNoMagic``) and testnets (``RequiresMagic``) - -Logging -======== - -Logs are output to the ``logs/`` dir. - -Profiling & statistics -====================== - -Profiling data and RTS run stats are stored in the ``profile/`` dir. - -Please see ``scripts/README.md`` for how to obtain profiling information using the scripts. Scripts ======= @@ -451,8 +440,6 @@ Testing Developers on ``cardano-node`` can `launch their own testnets `_ or `run the chairman tests `_ locally. -Chairman tests --------------- Debugging ====