diff --git a/README.md b/README.md index aeed142..8dafbf5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,63 @@ -# libbase + -encoding/decoding from arbitrary base \ No newline at end of file +

c++ encoding/decoding from arbitrary base

+ +
+ + Packaging status + + + latest packaged version(s) + +
+ +--- + +## Contents +[Installation](#installation) +[Contributing](#contributing) + +--- + +## Installation + +Automatically from specified repositories: + +[![Packaging status](https://repology.org/badge/vertical-allrepos/libbasen.svg)](https://repology.org/project/libbasen/versions) + +Manually using make: +``` +make -j $(nproc) +sudo make i USRDIR=(Your installation dir) +``` +Uninstall: +``` +sudo make uni USRDIR=(Your installation dir) +``` +For build with with debug flags: +``` +make -j $(nproc) DEBUG= +``` +For build tests: +``` +make tests -j $(nproc) DEBUG= +``` +And also flag for dynamic linking (if possible): +``` +make tools -j $(nproc) SHARED= +``` + +--- + +## Contributing + +Main branch is under protection rules, so you should create pull request. After merging will be runned [authors.sh](https://github.com/vSEK1RO/libbasen/blob/main/authors.sh) for adding all contributors usernames and their number of commits to [AUTHORS](https://github.com/vSEK1RO/libbasen/blob/main/AUTHORS) file. + +Now we would like to implement the following features: +- Base32 +- BCH +- Bech32 + +--- + +[:arrow_up:Contents](#contents) \ No newline at end of file