Added
- render(), render_stl() and visualize_stl()
- README.md for docs
- LICENSE and COPYING for license
Version Release
*Maintainers only*
Releasing is a two-step process: (1) releasing on Github and test.pypi and (2) releasing to pypi. Releasing on Github will automatically trigger a release on test.pypi via a Github Action. Following manual confirmation of a successful and satisfactory release on test.pypi, release on pypi is triggered manually with the Github Action "Publish on PyPi". There is also an option to publish to test.pypi and pypi from your local machine.
The first step in a release is determining if the release is a feature release or a maintenance release. A maintenance release is a backward compatible bug fix or documentation change, while a feature release adds functionality in a backward compatible manner.
Release Naming Conventions
This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html), which specifies a version number as MAJOR.MINOR.PATCH with a feature release mapped to a MINOR version and a maintenance release mapped to a PATCH.
The following are the release naming conventions:
1. Current Dev Version is obtained from `pyproject.toml`
* For maintenance release, the format is `{MAJOR.MINOR.PATCH}dev`
* For feature release, the format is `{MAJOR.MINOR}dev`
3. Release Version: Remove `dev` from Current Dev Version
4. Next Dev Version: Bumped version of Release Version with `dev` added to the end
* For maintenance release, bump PATCH
* For feature release, bump MINOR, do not specify PATCH
5. Source branch:
* For maintenance release, source branch is `maint-{MAJOR.MINOR}`
* For feature release, source branch is the main branch, `main`
Maintenance Release Example:
**IF** Current Dev Version == `1.1.1dev` **THEN**