diff --git a/changelog.md b/CHANGELOG.md similarity index 100% rename from changelog.md rename to CHANGELOG.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9cb6a8..b789a17 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,19 @@ # Contributing When contributing to this repository, please first discuss the change you wish to make via issue, -email, or any other method with the owners of this repository before making a change. +email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project. ## Pull Request Process -1. Ensure any install or build dependencies are removed before the end of the layer when doing a +1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. -2. Update the README.md with details of changes to the interface, this includes new environment +2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters. 3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). -4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you +4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. ## Code of Conduct @@ -89,4 +89,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi available at [http://contributor-covenant.org/version/1/4][version] [homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/readme.md b/README.md similarity index 93% rename from readme.md rename to README.md index 9980b02..54b5394 100644 --- a/readme.md +++ b/README.md @@ -5,14 +5,15 @@ - [Admin Panel](#admin-panel) - [Table of Content](#table-of-content) - [Description](#description) + - [Build](#build) - [Changelog](#changelog) - [Modules](#modules) - [Routes](#routes) - [Usage](#usage) - [Menus](#menus) - - [Usage](#usage-1) + - [Usage-2](#usage-2) - [Options](#options) - - [Usage](#usage-2) + - [Usage-3](#usage-3) - [Files/Folders architecture](#filesfolders-architecture) - [Configs files](#configs-files) - [site.json](#sitejson) @@ -22,6 +23,12 @@ WIP +## Build + +```console +composer install --no-dev --optimize-autoload +``` + ## Changelog see [changelog.md](./changelog.md) @@ -53,7 +60,7 @@ $module->addRoute("/regex-to-check-for-the-page/", $function); On the admin-side you can add menus & items -#### Usage +#### Usage-2 ```php $menu = $module->addMenu("Menu Name"); @@ -65,10 +72,9 @@ $pageFunction = function($settings) { $menu->addItem("Item Name", $pageFunction); ``` - ### Options -#### Usage +#### Usage-3 ```php $options = $module->addOptionItem("Item Name"); @@ -86,7 +92,7 @@ $options->addOption("optionVar", OptionTypes::Text, { ```js /* -possibilité de mettre des routes qui executent des functions +possibilité de mettre des routes qui executent des functions ajouter des pages dans la section d'admin (Module) to initialize & manage the module (Menu, Item from Menu) classes to manage adminPanel elements @@ -140,7 +146,6 @@ options.addOption("option name"=String, enum.text=enumeType, "option to check", - module.php - public.php (same as theme) - ## Configs files ### site.json