Yzena
/
Yc
2
1
Fork 0
C Utils for Yzena https://docs.yzena.com/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Gavin Howard a54e9940b3
Add dev docs about the hash submodule
3 days ago
benchmarks Update the XXH3/Spooky comparison benchmark 7 days ago
cmake@ec7ce30024 Change the license headers 11 months ago
docs Add dev docs about the hash submodule 3 days ago
include Rename sup to omu 4 days ago
samples Don't start a new thread if signals are not needed 1 week ago
src Rename sup to omu 4 days ago
tests Modify a fuzz test to output errors 3 days ago
tools Add more fields to GDB printers 5 days ago
.clang-format Fix problems in the code formatting infrastructure 1 month ago
.clang-tidy Add a .clang-tidy config file 4 months ago
.gitconfig Remove the scripts submodule 4 years ago
.gitignore Add a quicker way to check for multiple threads in the rwlock 3 months ago
.gitmodules Move the doc scripts into Yc 4 months ago
CMakeLists.txt Add a fuzz mode to use input files instead 3 days ago
LICENSE.AGPL.txt Add the actual license(s) to the repo 3 months ago
LICENSE.SSPL.txt Add the actual license(s) to the repo 3 months ago
LICENSE.YVUL.md Update the YVUL 3 months ago
LICENSE.md Put the docs under a CC license 1 month ago
NOTICE.md Add a header for endianness 5 days ago
README.md Fix the README 3 months ago
TODO.md Add y_nodiscard 3 weeks ago
bootstrap.sh Add the actual license(s) to the repo 3 months ago
build.gaml Add the actual license(s) to the repo 3 months ago
build.rig Add a separate main() function for all programs 3 months ago

README.md

Yc

WARNING: This project has moved to https://git.yzena.com/ for these reasons.

Yc is a library of utilities for C.

Yc is developed by Yzena.

Yc is Free and Open Source Software (FOSS). It is licensed under the Yzena Viral User License 0.1, the GNU AGPL, and the SSPL.

Getting Started

To get started, clone the repo, and then run the following commands in the root directory:

git config --local include.path ./.gitconfig
git submodule update --init --recursive

Dependencies

Yc depends on CMake. On Ubuntu, it can be installed with the following command:

sudo apt install cmake cmake-curses-gui

Status

Yc is not even in Alpha stage yet. This software is not ready for use.

Language

Yc is written in pure ISO C11.

Git Workflow

Yc uses the git workflow described here. Developers who want to contribute to Yc are encouraged to read that post carefully.

For feature branches, it uses rebase + merge --no-ff (option 3). It also uses a develop/master split. (Main development is on develop, and master just points to the latest tagged release to make it easy for users to get the latest release.)

Commit Messages

Projects under Yzena, including Yc, use the commit message guidelines laid out in this blog post.

Semantic Versioning

Yc uses semantic versioning.

Open Source, Not Open Contribution

Similar to SQLite and Litestream, Yc is open source, not open contribution, for many reasons:

  • The code uses specific implementations of math and bit operations to avoid undefined behavior, so the code "looks" wrong at first glance.
  • New features are required to have a requirements document, a comprehensive specification (preferably in a formal specification language), fully fleshed-out design documents, and a comprehensive test suite.
  • The code uses features specifically in this library to provide the semantics of Rust's borrow checker, but in C. This will also be confusing to newcomers, especially since it uses Structured Concurrency.
  • The code uses an internal build system.
  • The code style is my own slightly eccentric style.

Contents Listing

Every folder contains a README file which lists the purposes for the files and folders in that directory.

Contents

Files:

CMakeLists.txt  CMake is the build system used for Yc. This is the root
                config file.
LICENSE.md      A Markdown version of the Yzena Network License 0.1.
NOTICE.md       The NOTICE file required by the Yzena Network License.

Folders:

cmake       Contains CMake utilities.
docs        Contains all of the documentation for Yc (currently empty).
include     Contains all of the public header files for Yc.
src         All of Yc's source code.
tests       Tests for Yc.