diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..d6ab8df --- /dev/null +++ b/Readme.md @@ -0,0 +1,106 @@ +Uoke Manual +=================== +Hey! Welcome to **Uoke Framework**. + +Version: 1.0 + +---------- + +Environment Requirement +------------- +| Require | Lowest | Normal | Highest +| :------- | :----: | :---: |:---: | +| PHP | x | x | 7.x +| MySQL | x | x | x + + +Structure +------------- + + +#### `/` (Root Directory) + +/class +config.php - Global configuration file, which includes DB, log and cookies policy et cetera. +/data +/template + +#### /class + + + +#### /data + + + +#### /template + +As its name implies, it storage the template. +For convenient, all static resources(front-end template,css,js...) put them into here. + +---------- + + +Naming +------------------- + +To be continued... + +> **Note:** + +> - N/A + +#### For file + + + +#### For class + + + +#### For method + + +> **Note:** The button is disabled when you have no document to synchronize. + +---------- + + +Examples +------------- +``` + +``` +To be continued... + +#### Eg.1 Login +``` +// Foo +var bar = 0; +``` + + +#### Eg.2 SQL query (Registration,Data Fetch) + + +---------- + + +Others +-------------------- + +### Declaration + +Use Term +Distribute Term +: A +: B + + > part of definition + + + +### Support Uoke + + +Uoke Framework is a full-featured, open-source framework, created by Handsome [Cheng Yi](https://github.com/knowsee)