Skip to content
Snippets Groups Projects
Commit 0ebef47a authored by Moul's avatar Moul
Browse files

readme/contributing: update links to website (#433)

Consider deleting some links
Would still work from GitLab and MkDocs website

Update link in coverage badge

Add Material for MkDocs badge
https://squidfunk.github.io/mkdocs-material/blog/2023/11/30/adding-a-badge-to-your-project/

Remove website repo sources
parent f18c951a
No related branches found
No related tags found
1 merge request!271Set up new website structure with MkDocs (#433)
......@@ -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.
......
......@@ -7,10 +7,11 @@
[![Python versions](https://img.shields.io/pypi/pyversions/silkaj.svg?logo=python&label=Python&logoColor=gold)](https://pypi.python.org/pypi/silkaj)
[![Code format](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![Coverage report](https://git.duniter.org/clients/python/silkaj/badges/main/coverage.svg)](https://clients.pages.duniter.org/python/silkaj/index.html)
[![Coverage report](https://git.duniter.org/clients/python/silkaj/badges/main/coverage.svg)](https://silkaj.duniter.org/latest/coverage/)
[![Website](https://img.shields.io/website/https/silkaj.duniter.org.svg)](https://silkaj.duniter.org)
[![Dev pipeline status](https://git.duniter.org/clients/python/silkaj/badges/main/pipeline.svg)](https://git.duniter.org/clients/python/silkaj/)
[![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](http://www.mypy-lang.org/)
[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](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
[![Packaging status](https://repology.org/badge/vertical-allrepos/silkaj.svg)](https://repology.org/project/silkaj/versions)
......@@ -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).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment