Lindenii Project Forge
Login

go-lindenii-common

Common library for the Lindenii Project
Commit info
ID
7faa1daa65b0d2fe6fd88adff2d9a1dc3ee45085
Author
Runxi Yu <me@runxiyu.org>
Author date
Sat, 04 Jan 2025 20:43:21 +0800
Committer
Runxi Yu <me@runxiyu.org>
Committer date
Sat, 04 Jan 2025 20:43:21 +0800
Actions
README: Add warning about Linux-only system calls
# Common Go libraries for Lindenii projects

## Warning

Currently this only works on Linux because we use Linux-specific system calls.
This needs to be addressed in the future.

## 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`