|
|
|
@ -1,15 +1,14 @@
|
|
|
|
|
# Yc
|
|
|
|
|
|
|
|
|
|
***WARNING: This project has moved to [https://git.yzena.com/][10] for [these
|
|
|
|
|
reasons][11].***
|
|
|
|
|
***WARNING: This project has moved to [https://git.yzena.com/][6] for [these
|
|
|
|
|
reasons][7].***
|
|
|
|
|
|
|
|
|
|
Yc is a library of utilities for C.
|
|
|
|
|
|
|
|
|
|
Yc is developed by [Yzena][1].
|
|
|
|
|
|
|
|
|
|
Yc is Free and Open Source Software (FOSS). It is licensed under a modified
|
|
|
|
|
[Apache License 2.0][2]. The [modification][3] was first used by
|
|
|
|
|
[Pixar Animation Studios][4] for use on the [OpenSubdiv][5] project.
|
|
|
|
|
Yc is Free and Open Source Software (FOSS). It is licensed under the [Yzena
|
|
|
|
|
Network License 0.1][2].
|
|
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
|
|
|
@ -39,7 +38,7 @@ Yc is written in pure ISO C11.
|
|
|
|
|
|
|
|
|
|
## Git Workflow
|
|
|
|
|
|
|
|
|
|
Yc uses the git workflow described [here][7]. Developers who want to contribute
|
|
|
|
|
Yc uses the git workflow described [here][3]. 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
|
|
|
|
@ -50,15 +49,15 @@ release.)
|
|
|
|
|
## Commit Messages
|
|
|
|
|
|
|
|
|
|
Projects under Yzena, including Yc, use the commit message guidelines laid out
|
|
|
|
|
in [this blog post][8].
|
|
|
|
|
in [this blog post][4].
|
|
|
|
|
|
|
|
|
|
## Semantic Versioning
|
|
|
|
|
|
|
|
|
|
Yc uses [semantic versioning][9].
|
|
|
|
|
Yc uses [semantic versioning][5].
|
|
|
|
|
|
|
|
|
|
## Open Source, Not Open Contribution
|
|
|
|
|
|
|
|
|
|
Similar to [SQLite][13] and [Litestream][12], Yc is open source, not open
|
|
|
|
|
Similar to [SQLite][9] and [Litestream][8], Yc is open source, not open
|
|
|
|
|
contribution, for many reasons:
|
|
|
|
|
|
|
|
|
|
* The code uses specific implementations of math and bit operations to avoid
|
|
|
|
@ -68,7 +67,7 @@ contribution, for many reasons:
|
|
|
|
|
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][14].
|
|
|
|
|
especially since it uses [Structured Concurrency][10].
|
|
|
|
|
* The code uses an internal build system.
|
|
|
|
|
* The code style is my own slightly eccentric style.
|
|
|
|
|
|
|
|
|
@ -83,8 +82,8 @@ Files:
|
|
|
|
|
|
|
|
|
|
CMakeLists.txt CMake is the build system used for Yc. This is the root
|
|
|
|
|
config file.
|
|
|
|
|
LICENSE.md A Markdown version of Pixar's modified Apache 2.0 license.
|
|
|
|
|
NOTICE.md The NOTICE file required by the Apache License.
|
|
|
|
|
LICENSE.md A Markdown version of the Yzena Network License 0.1.
|
|
|
|
|
NOTICE.md The NOTICE file required by the Yzena Network License.
|
|
|
|
|
|
|
|
|
|
Folders:
|
|
|
|
|
|
|
|
|
@ -95,16 +94,12 @@ Folders:
|
|
|
|
|
tests Tests for Yc.
|
|
|
|
|
|
|
|
|
|
[1]: http://yzena.com/
|
|
|
|
|
[2]: https://www.apache.org/licenses/LICENSE-2.0.html
|
|
|
|
|
[3]: http://graphics.pixar.com/opensubdiv/docs/license.html
|
|
|
|
|
[4]: https://www.pixar.com/
|
|
|
|
|
[5]: http://graphics.pixar.com/opensubdiv/docs/intro.html
|
|
|
|
|
[6]: https://github.com/YzenaTech/Yc
|
|
|
|
|
[7]: http://endoflineblog.com/oneflow-a-git-branching-model-and-workflow
|
|
|
|
|
[8]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
|
|
|
|
|
[9]: http://semver.org/
|
|
|
|
|
[10]: https://git.yzena.com/Yzena/Yc
|
|
|
|
|
[11]: https://gavinhoward.com/2020/04/i-am-moving-away-from-github/
|
|
|
|
|
[12]: https://github.com/benbjohnson/litestream#open-source-not-open-contribution
|
|
|
|
|
[13]: https://www.sqlite.org/copyright.html
|
|
|
|
|
[14]: https://gavinhoward.com/2019/12/structured-concurrency-definition/
|
|
|
|
|
[2]: https://yzena.com/yzena-network-license/
|
|
|
|
|
[3]: http://endoflineblog.com/oneflow-a-git-branching-model-and-workflow
|
|
|
|
|
[4]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
|
|
|
|
|
[5]: http://semver.org/
|
|
|
|
|
[6]: https://git.yzena.com/Yzena/Yc
|
|
|
|
|
[7]: https://gavinhoward.com/2020/04/i-am-moving-away-from-github/
|
|
|
|
|
[8]: https://github.com/benbjohnson/litestream#open-source-not-open-contribution
|
|
|
|
|
[9]: https://www.sqlite.org/copyright.html
|
|
|
|
|
[10]: https://gavinhoward.com/2019/12/structured-concurrency-definition/
|
|
|
|
|