sily library for D programming language.
sily is a general-purpose library containing utilities for general programming and game development.
![REUSE Compliance Check](https://github.com/al1-ce/sily/actions/workflows/reuse.yml/badge.svg)
Usage
Documentation can be found here
Versioning (Will be effective since 6.0)
Library follows semantic versioning (x.y.z
where x
is Major release, y
is Minor release and z
is Patch). This means that:
- 1.0.Z - Patch version signified bugfixes and minor changes
- Patches are compatible with each other
- You can safely change from one patch to another
- You can specify version in project config file as {@s "~>x.y"}
- 1.Y.0 - Minor version signifies new features
- Minor versions are not backwards-compatible
- You can safely upgrade from lower Minor release to higher Minor release
- You can specify version in project config file as {@s "~>x"} if you're using features only from first minor release
- X.0.0 - Major version signifies breaking or removal of features
- Major releases are not compatible with each other
- You might have to fix your code in case of deprecations or major changes
- Deprecation will be removed in every Major release
- Deprecations will be introduces in Minor releases by tagging deprecated code with
{@t @}{@k deprecated}({@s "x.y.z - Why"})
, where {@s "x.y.z"} is version where code was deprecated and {@s "Why"} is reason for removal or what to use instead
Example:
Version 1.0.0 - Initial release
Version 1.0.1 - Fixed functionA and structA
Version 1.0.2 - Fixed functionB
Version 1.1.0 - Moved functionB to moduleB
functionB marked @deprecated("1.1.0 - Moved to moduleB")
Version 1.1.1 - Fixed functionC
Version 1.2.0 - Added structB
Version 2.0.0 - structA now has different logic. Removed functionB from moduleA
Development
Contributing
See CONTRIBUTING.md.
License
- Copy of used licenses can be found in
LICENSES
folder. Main license can be found in LICENSE file.
- List of authors can be found in AUTHORS.md.
This project is REUSE compliant.