diff --git a/.gitignore b/.gitignore index 7fa6a6d9..a4c5d4e3 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ config.toml /builds data/ output.log +tmp/ diff --git a/crates/floresta/src/lib.rs b/crates/floresta/src/lib.rs index fb6767b5..2fb1d465 100644 --- a/crates/floresta/src/lib.rs +++ b/crates/floresta/src/lib.rs @@ -20,7 +20,7 @@ //! handle the peer-to-peer protocol. It is not a full node, it doesn't store the blockchain //! or validate data, it just sends and receives messages. //! -//! Floresta also provides a simple watch-only wallet an an electrum server implementation. +//! Floresta also provides a simple watch-only wallet and an electrum server implementation. //! They are meant to be used in `florestad`, a full node implementation that uses all the //! crates in this project. //! diff --git a/readme.md b/readme.md index 37e190dc..5d72ea75 100644 --- a/readme.md +++ b/readme.md @@ -56,11 +56,25 @@ cargo run --release -- -c config.toml --network signet run ``` ### Running the tests + +#### Requirements + +```bash +cargo build +``` + There's a set of unit tests that you can run with ```bash cargo test ``` +There's also a set of functional tests that you can run with + +```bash +pip3 install -r tests/requirements.txt +python tests/run_tests.py +``` + ### Contributing Contributions are welcome, feel free to open an issue or a pull request. There's not really a set of guidelines for contributing other than the code compiling and the tests passing. If you want to contribute but don't know where to start, take a look at the issues, there's a few of them marked as `good first issue`.