diff --git a/readme/development.md b/readme/development.md index 7fca5f6c..dc46dfd7 100644 --- a/readme/development.md +++ b/readme/development.md @@ -1,5 +1,8 @@ # Development +Contributions are very welcome, I will gladly review and discuss any merge +requests. + ## Roadmap - [x] show a dropdown to select valid devices @@ -36,4 +39,26 @@ coverage combine && coverage report -m ``` To read events, `evtest` is very helpful. Add `-d` to `key-mapper-gtk` -to get debug output. \ No newline at end of file +to get debug output. + +## Releasing + +ssh/login into a ubuntu machine + +```bash +./scripts/build.sh +``` + +this will generate `key-mapper/deb_dist/python3-key-mapper_0.3.1-1_all.deb` +depending on the version configured in setup.py + +## Badges + +```bash +sudo pip install git+https://github.com/jongracecox/anybadge +sudo pip install git+https://github.com/dbrgn/coverage-badge +./scripts/badges.sh +``` + +new badges, if needed, will be created in `readme/` and they +just need to be commited.