ncc/README.md

63 lines
2.2 KiB
Markdown
Raw Normal View History

2022-04-17 17:53:46 -04:00
# ![NCC](assets/icon/ncc_32px.png "NCC") NCC
2022-04-02 22:59:12 -04:00
2022-04-16 19:31:41 -04:00
Nosial Code Compiler is a program written in PHP designed to be a multi-purpose compiler, package manager and toolkit.
2022-05-09 20:07:53 +01:00
This program is a complete re-write of the now defunct [PHP Package Manager (PPM)](https://git.n64.cc/intellivoid/ppm)
toolkit offering more features, security and proper code licensing and copyrighting for the components used for the project.
2023-01-29 23:27:56 +00:00
## Alpha Stage
2022-05-09 20:07:53 +01:00
2023-01-29 23:27:56 +00:00
NCC is currently in alpha stage, meaning that it's not fully functional and may not work on your system. If you find any bugs
2023-06-29 15:39:56 -04:00
or issues please report them to the [GitHub Issue Tracker](https://git.n64.cc/nosial/ncc/issues).
2022-04-16 19:31:41 -04:00
2023-01-29 23:27:56 +00:00
At the moment NCC is currently being used while developing other software, this serves as a test run to
improve on changes for the next version.
2022-04-17 17:00:27 -04:00
2023-02-05 16:42:47 -05:00
## Changelog
2022-04-17 17:00:27 -04:00
2023-02-05 16:42:47 -05:00
The changelog for NCC can be found in the [CHANGELOG.md](CHANGELOG.md) file.
2022-04-17 17:00:27 -04:00
2023-01-29 23:27:56 +00:00
## Repository Mirrors
2022-04-17 17:00:27 -04:00
2023-06-29 15:39:56 -04:00
The official repository for NCC is hosted on [GitLab](https://git.n64.cc/nosial/ncc), however, you can also find
2023-01-29 23:27:56 +00:00
mirrors of the repository mirrored on different platforms, including
community powered mirrors. (more to come)
2022-04-17 17:00:27 -04:00
2023-01-29 23:27:56 +00:00
- [git.it-kuny.ch](https://git.it-kuny.ch)
- [git.martinvlba.eu](https://git.martinvlba.eu/Nosial/ncc)
2022-05-24 20:51:20 -04:00
2022-04-17 16:37:59 -04:00
2023-01-29 23:27:56 +00:00
# Contributing
We welcome contributions to NCC! If you have an idea for how to improve the project, please don't hesitate to reach out.
There are many ways to contribute, and we appreciate all forms of support.
For more information on how to contribute, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
# Code of Conduct
We are committed to maintaining a welcoming and inclusive environment for all contributors. Please read and follow our
[Code of Conduct](CODE_OF_CONDUCT.md).
# Authors
- Zi Xing Narrakas (netkas) <[netkas@n64.cc](mailto:netkas@64.cc)>
# Special Thanks
- Marc Gutt (mgutt) <[marc@gutt.it](mailto:marc@gutt.it)>
- Debusschère Alexandre ([debuss](https://github.com/debuss))
# Copyright
- Copyright (c) 2022-2023, Nosial - All Rights Reserved
2022-04-16 19:31:41 -04:00
# Licenses
2023-01-29 23:27:56 +00:00
NCC is licensed under the MIT License, see [LICENSE](LICENSE) for more information.
Multiple licenses for the open source components used in this
project can be found at [LICENSE](LICENSES)