diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 69ae5c1b72b2f5eb70222afdf50784485940869c..7f560692092a4ede65efb873f126d014c45784f0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Part of the Duniter project running the Äž1 currency, Silkaj project is aiming a ## Install the development environment -We are using [Poetry](https://python-poetry.org/) as a development environment solution. Start [installing Poetry](doc/install_poetry.md). +We are using [Poetry](https://python-poetry.org/) as a development environment solution. Start [installing Poetry](/install_poetry/). This will install a sandboxed Python environment. Dependencies will be installed in it in order to have Silkaj running and to have pre-installed developement tools. @@ -108,7 +108,7 @@ Check out duniterpy#169 for more details. ## Tests -We are using [Pytest](https://pytest.org) as a tests framework. To know more about how Silkaj implement it read the [project test documentation](doc/test_and_coverage.md). +We are using [Pytest](https://pytest.org) as a tests framework. To know more about how Silkaj implement it read the [project test documentation](/test_and_coverage/). Tests are stored into `unit` and `integration` folders depending on their types, then using the same tree as the source code. diff --git a/README.md b/README.md index 82503856fe3514dd2df93352d2a99545a30b2c29..13fe30010388d846d284c2035af229e399ab34dc 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,11 @@ [](https://pypi.python.org/pypi/silkaj) [](https://github.com/psf/black) [](https://pycqa.github.io/isort/) -[](https://clients.pages.duniter.org/python/silkaj/index.html) +[](https://silkaj.duniter.org/latest/coverage/) [](https://silkaj.duniter.org) [](https://git.duniter.org/clients/python/silkaj/) [](http://www.mypy-lang.org/) +[](https://squidfunk.github.io/mkdocs-material/) Command line client for Äž1 libre-currency powered by Duniter @@ -24,7 +25,7 @@ Install with your favorite package manager. See below the [packaging status para ### Pipx -If you want a more recent version [install with pipx](doc/install_pipx.md): +If you want a more recent version [install with pipx](https://silkaj.duniter.org/install_pipx/): ```bash sudo apt install pipx @@ -35,12 +36,12 @@ pipx install silkaj There is two kind of images. One build with `pip` for user purposes, and one using Poetry for developer purposes. -- [Docker images](doc/docker.md) +- [Docker images](https://silkaj.duniter.org/docker/) ### For contributing purposes -- [Install the Poetry development environment](doc/install_poetry.md) -- Check out the [contributing guidelines](CONTRIBUTING.md) +- [Install the Poetry development environment](https://silkaj.duniter.org/install_poetry/) +- Check out the [contributing guidelines](https://silkaj.duniter.org/contributing/) ## Usage @@ -92,7 +93,7 @@ silkaj -ep <hostname>:<port>/<path> <sub-command> - Certification emission - Membership emission - Revocation file handling -- [DeathReaper: exclusions reports on Discourse forums](doc/deathreaper.md) +- [DeathReaper: exclusions reports on Discourse forums](https://silkaj.duniter.org/deathreaper/) ### Authentication @@ -105,7 +106,7 @@ silkaj -ep <hostname>:<port>/<path> <sub-command> ## Wrappers -- [How-to: automate transactions and multi-output](doc/how-to_automate_transactions_and_multi-output.md) +- [How-to: automate transactions and multi-output](https://silkaj.duniter.org/how-to_automate_transactions_and_multi-output/) - [Transaction generator written in Shell](https://gitlab.com/jytou/tgen) - [Äž1Cotis](https://git.duniter.org/matograine/g1-cotis) - [G1pourboire](https://git.duniter.org/matograine/g1pourboire) @@ -133,10 +134,6 @@ I wanted to call that program: I finally called it `Silkaj` as `Silk` in esperanto. -### Website - -- [Silkaj website sources](https://git.duniter.org/websites/silkaj_website/) - ## Packaging status [](https://repology.org/project/silkaj/versions) diff --git a/docs/install_poetry.md b/docs/install_poetry.md index aa20ca66b5b602f1cf044684b758bd20b9ca2753..e817f87a45182fff43857cc9b83811f335c1bbe7 100644 --- a/docs/install_poetry.md +++ b/docs/install_poetry.md @@ -65,7 +65,3 @@ Add following alias to your shell configuration: ```bash alias silkaj="cd /path/to/silkaj && poetry run silkaj" ``` - -### Contribute - -Follow the [contributing guide](CONTRIBUTING.md).