Renamed README, CHANGELOG

and added basic build informations in README
This commit is contained in:
Florian Bouillon 2019-03-29 00:04:21 +01:00
parent 6914ffc307
commit b377734ea6
3 changed files with 17 additions and 12 deletions

View File

@ -5,14 +5,15 @@
- [Admin Panel](#admin-panel) - [Admin Panel](#admin-panel)
- [Table of Content](#table-of-content) - [Table of Content](#table-of-content)
- [Description](#description) - [Description](#description)
- [Build](#build)
- [Changelog](#changelog) - [Changelog](#changelog)
- [Modules](#modules) - [Modules](#modules)
- [Routes](#routes) - [Routes](#routes)
- [Usage](#usage) - [Usage](#usage)
- [Menus](#menus) - [Menus](#menus)
- [Usage](#usage-1) - [Usage-2](#usage-2)
- [Options](#options) - [Options](#options)
- [Usage](#usage-2) - [Usage-3](#usage-3)
- [Files/Folders architecture](#filesfolders-architecture) - [Files/Folders architecture](#filesfolders-architecture)
- [Configs files](#configs-files) - [Configs files](#configs-files)
- [site.json](#sitejson) - [site.json](#sitejson)
@ -22,6 +23,12 @@
WIP WIP
## Build
```console
composer install --no-dev --optimize-autoload
```
## Changelog ## Changelog
see [changelog.md](./changelog.md) 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 On the admin-side you can add menus & items
#### Usage #### Usage-2
```php ```php
$menu = $module->addMenu("Menu Name"); $menu = $module->addMenu("Menu Name");
@ -65,10 +72,9 @@ $pageFunction = function($settings) {
$menu->addItem("Item Name", $pageFunction); $menu->addItem("Item Name", $pageFunction);
``` ```
### Options ### Options
#### Usage #### Usage-3
```php ```php
$options = $module->addOptionItem("Item Name"); $options = $module->addOptionItem("Item Name");
@ -86,7 +92,7 @@ $options->addOption("optionVar", OptionTypes::Text, {
```js ```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 ajouter des pages dans la section d'admin
(Module) to initialize & manage the module (Module) to initialize & manage the module
(Menu, Item from Menu) classes to manage adminPanel elements (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 - module.php
- public.php (same as theme) - public.php (same as theme)
## Configs files ## Configs files
### site.json ### site.json