C Utils for Yzena
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 3c4bce0bb0
Remove any final trace of outside code from Yc
3 months ago
benchmarks Change the license headers 3 months ago
cmake@ec7ce30024 Change the license headers 3 months ago
docs Remove any final trace of outside code from Yc 3 months ago
include Remove any final trace of outside code from Yc 3 months ago
lib Change the license headers 3 months ago
res Change the license headers 3 months ago
samples Change the license headers 3 months ago
src Remove any final trace of outside code from Yc 3 months ago
tests Remove any final trace of outside code from Yc 3 months ago
.clang-format Add clang-format officially as the autoformatter 10 months ago
.gitconfig Initial commit of template with cmake submodule 3 years ago
.gitignore Make the yvm compiler output no warnings 8 months ago
.gitmodules Make doc gen work with compression 6 months ago
.travis.yml Change copyrights 2 years ago
CMakeLists.txt Change the license headers 3 months ago
LICENSE.md Update the license 3 months ago
NOTICE.md Change the license headers 3 months ago
README.md Change the license headers 3 months ago
TODO.md Add a couple of TODO items 9 months ago
bootstrap.sh Change the license headers 3 months ago
clang_cflags.txt Do a lot of work of renaming and moving stuff around 1 year ago
format.sh Change the license headers 3 months ago
lint.sh Change the license headers 3 months ago
tsp.json Update tsp 6 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 Network License 0.1.

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.