Skip to content

Commit

Permalink
README: fix a few really outdated bits
Browse files Browse the repository at this point in the history
  • Loading branch information
deepfire committed Aug 23, 2022
1 parent 20d7e3f commit 1c5e316
Showing 1 changed file with 2 additions and 15 deletions.
17 changes: 2 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/input-output-hk/cardano-node/blob/master/configuration/defaults/byron-mainnet/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
=======

Expand Down Expand Up @@ -451,8 +440,6 @@ Testing

Developers on ``cardano-node`` can `launch their own testnets <doc/getting-started/launching-a-testnet.md>`_ or `run the chairman tests <doc/getting-started/running-chairman-tests.md>`_ locally.

Chairman tests
--------------

Debugging
====
Expand Down

0 comments on commit 1c5e316

Please sign in to comment.