Otherway/sugar-cube-client
2
0
Fork 0
mirror of https://github.com/sitelease/sugar-cube-client.git synced 2025-10-31 20:12:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added a user guide based on MkDocs

Browse Source
This commit is contained in:
Cédric Belin
2018-11-21 17:53:26 +01:00
parent 21d1131813
commit 4e9e67a695
11 changed files with 211 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
doc/index.md Normal file
View File

@ -0,0 +1,15 @@
# Gitea <small>for PHP</small>
## Yet another implementation of enumerated types
This implementation, based on [traits](https://secure.php.net/manual/en/language.oop5.traits.php), does not try to reproduce the semantics of traditional enumerations, like the ones found in C# or Java languages.
Unlike other [PHP](https://secure.php.net) implementations, like the [SplEnum](https://secure.php.net/manual/en/class.splgitea.php) class, it does not rely on object instances. Instead, it just gives a set of static methods to ease working with the `public` constants of a class representing an enumerated type.
## Quick start
Install the latest version of **Enums for PHP** with [Composer](https://getcomposer.org):
```shell
composer require sab-international/gitea
```
For detailed instructions, see the [installation guide](installation.md).