98 lines
2.2 KiB
Markdown
98 lines
2.2 KiB
Markdown
# libbasen
|
|
|
|
c++20 encoding/decoding from arbitrary base
|
|
|
|
<a href="https://repology.org/project/libbasen/versions">
|
|
<img src="https://repology.org/badge/tiny-repos/libbasen.svg" alt="Packaging status">
|
|
</a>
|
|
<a href="https://repology.org/project/libbasen/versions">
|
|
<img src="https://repology.org/badge/latest-versions/libbasen.svg" alt="latest packaged version(s)">
|
|
</a>
|
|
|
|
## Contents
|
|
|
|
- [Installation](#installation)
|
|
- [Package](#package)
|
|
- [Make](#make)
|
|
- [CMake](#cmake)
|
|
- [Documentation](#documentation)
|
|
- [Usage](#usage)
|
|
- [Contributing](#contributing)
|
|
|
|
## Installation
|
|
|
|
### Package
|
|
|
|
[](https://repology.org/project/libbasen/versions)
|
|
|
|
### Make
|
|
|
|
For cli tool you should have [argparse](https://github.com/p-ranav/argparse) as make dependency.
|
|
|
|
Install:
|
|
```
|
|
make -j $(nproc)
|
|
sudo make i USRDIR=(Your installation dir)
|
|
```
|
|
Uninstall:
|
|
```
|
|
sudo make uni USRDIR=(Your installation dir)
|
|
```
|
|
|
|
### CMake
|
|
|
|
For using as dependency only (without cli tool, test, coverage, docs)
|
|
|
|
```
|
|
include(FetchContent)
|
|
FetchContent_Declare(
|
|
basen
|
|
GIT_REPOSITORY https://github.com/vSEK1RO/libbasen.git
|
|
GIT_TAG latest
|
|
)
|
|
FetchContent_MakeAvailable(basen)
|
|
|
|
target_link_libraries(MyProject PRIVATE basen::basen)
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Available [here](https://vsek1ro.github.io/libbasen)
|
|
|
|
## Usage
|
|
|
|
libbasen package provides `basen` cli tool. Below are examples of use:
|
|
```
|
|
echo "hello world" | basen -t hex > encoded.data
|
|
```
|
|
```
|
|
basen -t hex -d < encoded.data > decoded.data
|
|
```
|
|
```
|
|
echo "arbitrary alphabet" | basen -a "0123ABCD"
|
|
```
|
|
|
|
## 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
|
|
|
|
For build with with debug flags:
|
|
```
|
|
make -j $(nproc) DEBUG=
|
|
```
|
|
For build tests (needed gtest package as dependency):
|
|
```
|
|
make tests -j $(nproc) DEBUG=
|
|
```
|
|
For generating coverage:
|
|
```
|
|
make cover -j $(nproc) DEBUG=
|
|
```
|
|
|
|
[⬆️ Contents](#contents)
|