Nosial/ncc
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 11 Packages Wiki Activity Actions

Updated README.md

Browse source
This commit is contained in:
Netkas 2023-10-10 19:08:25 -04:00
parent af9f3fba22
commit 68ea83c103
No known key found for this signature in database
GPG key ID: 5DAF58535614062B
1 changed files with 41 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
README.md
View file

@ -2,27 +2,52 @@
[![wakatime](https://wakatime.com/badge/user/bc15cc8e-c9b9-4c11-bad9-3e3cfacf01e4/project/273bc06f-12e7-43d7-824d-40a78b02aada.svg)](https://wakatime.com/badge/user/bc15cc8e-c9b9-4c11-bad9-3e3cfacf01e4/project/273bc06f-12e7-43d7-824d-40a78b02aada)
Nosial Code Compiler is a program written in PHP designed to be a multi-purpose compiler, package manager and toolkit.
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.
Nosial Code Compiler is a package compiler, manager & installer for PHP. Allowing you to install and manage multiple
versions of php packages on your system that your PHP programs/projects can share and use. Additionally, ncc also allows
you to create a redistributable package of your PHP program/project in the form of a `.ncc` binary package file.
## Alpha Stage
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
or issues please report them to the [GitHub Issue Tracker](https://git.n64.cc/nosial/ncc/issues).
## Features
- [x] Package Manager
- [x] Support for repositories such as GitHub, GitLab, GitTea and Packagist
- [x] Package compiler
- [x] Execution Handler
- [x] Import System (*No need for autoloaders!*)
## Dependencies
- PHP 8.0 or higher
- php-mbstring extension
- php-zip extension
- php-mbcrypt extension
- php-ctype extension
- php-curl extension
## Documentation
Extensive documentation for ncc can be found on at [DOCUMENTATION.md](DOCUMENTATION.md), explaining how from how to
build and install ncc to how to use it, it is highly recommended that you read the documentation before using ncc.
## Bugs and issues
If you encounter any bugs or issues with ncc, please report them on the [issue tracker](https://git.n64.cc/nosial/ncc/-/issues).
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.
## Changelog
The changelog for ncc can be found in the [CHANGELOG.md](CHANGELOG.md) file.
## Repository Mirrors
The official repository for ncc is hosted on [GitLab](https://git.n64.cc/nosial/ncc), however, you can also find
The official repository for ncc is hosted on [n64](https://git.n64.cc/nosial/ncc); however, you can also find
mirrors of the repository mirrored on different platforms, including
community powered mirrors. (more to come)
community-powered mirrors. (more to come)
- [git.it-kuny.ch](https://git.it-kuny.ch)
- [git.martinvlba.eu](https://git.martinvlba.eu/Nosial/ncc)
@ -37,11 +62,13 @@ 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)>
@ -51,16 +78,16 @@ We are committed to maintaining a welcoming and inclusive environment for all co
- Marc Gutt (mgutt) <[marc@gutt.it](mailto:marc@gutt.it)>
- Debusschère Alexandre ([debuss](https://github.com/debuss))
- badPointer <[https://git.n64.cc/badPointer](https://git.n64.cc/badPointer)>
- Cybersecbyte <[https://git.n64.cc/Cybersecbyte](https://git.n64.cc/Cybersecbyte)>
# Copyright
- Copyright (c) 2022-2023, Nosial - All Rights Reserved
- Copyright (c) 2022-2023, Nosial—All Rights Reserved
# Licenses
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)
Multiple licenses for the open-source components used in this project can be found at [LICENSE](LICENSES)