path: root/README.md

# Common Go libraries for Lindenii projects

## Ported/forked packages

| Name | Description                   | Origin   | License      |
| -    | -                             | -        | -            |
| scfg | Configuration parsing library | emersion | MIT          |
| cmap | Generic concurrent maps       | Go       | BSD-3-Clause |

## Custom packages

All custom packages are licensed under CC0-1.0.

| Name | Description       |
| -    | -                 |
| misc | Misc functions    |
| clog | Logging utilities |

## Conventions

The Lindenii project's Go style follows the standard Go style as produced by
[gofumpt](https://github.com/mvdan/gofumpt), except in identifier naming.

* Types end with `_t`.
* Constants are `UPPER_SNAKE_CASE`.
* Variables and unexported functions and fields are `lower_snake_case`
* Exported functions and fields are `Capitalized_snake_case`