X-Git-Url: https://jfr.im/git/uguu.git/blobdiff_plain/c3324d98c6ed8d2e936305eae9149e27c18c895a..b2eba08767dc1c5f8b6500399fba13bf5057c708:/README.md diff --git a/README.md b/README.md index 470dbd5..b0ab898 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Uguu [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu) -[![MIT -licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/nokonoko/uguu/master/LICENSE) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se) @@ -27,21 +26,31 @@ See the real world site at [uguu.se](https://uguu.se). ## Requirements -Original development environment is Nginx + PHP8.1 + SQLite, but is confirmed to -work with Apache and older PHP versions like PHP7.4. +Tested and working with Nginx + PHP-8.0/8.1 + SQLite/MySQL. -Node is used to compile Uguu. +Node is used to compile Uguu, after that it runs on PHP. ## Installation Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se). -If you need a admin panel check out [Moe Panel](https://github.com/pomf/MoePanel). +If you need a admin panel check out [Moe Panel](https://git.pomf.se/Pomf/MoePanel). ## Getting help Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se +## Contributing + +We'd really like if you can take some time to make sure your coding style is +consistent with the project. Uguu follows [PHP +PSR-12](https://www.php-fig.org/psr/psr-12/) and [Airbnb JavaScript +(ES5)](https://github.com/airbnb/javascript/tree/es5-deprecated/es5) (`airbnb/legacy`) +coding style guides. We use ESLint and PHPCS tools to enforce these standards. + +You can also help by sending us feature requests or writing documentation and +tests. + ## Credits Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Eric Johansson (nekunekus) and with help from the open source community.