mirror of
https://github.com/Karaka-Management/Developer-Guide.git
synced 2026-02-07 08:18:39 +00:00
fix docs
This commit is contained in:
parent
0bb0807f28
commit
29c8f1fd95
|
|
@ -1,8 +1,10 @@
|
||||||
# General
|
# General
|
||||||
* [Introduction]({%}?page=README)
|
* [Introduction]({%}?page=README)
|
||||||
* [Setup]({%}?page=general/setup)
|
|
||||||
* [Application Structure]({%}?page=general/structure)
|
* [Application Structure]({%}?page=general/structure)
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
* [Install]({%}?page=general/setup)
|
||||||
|
|
||||||
## Quality & Standards
|
## Quality & Standards
|
||||||
* [Code Inspections & Tests]({%}?page=quality/inspections)
|
* [Code Inspections & Tests]({%}?page=quality/inspections)
|
||||||
* [Documentation Standards]({%}?page=standards/documentation)
|
* [Documentation Standards]({%}?page=standards/documentation)
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
# Setup
|
# Install
|
||||||
|
|
||||||
In order to setup the application for development for the first time please see the following instructions and recommendations.
|
In order to setup the application for development for the first time please see the following instructions and recommendations.
|
||||||
|
|
||||||
|
|
@ -115,4 +115,17 @@ After the installation you'll have access to the following content:
|
||||||
|
|
||||||
### Annotation
|
### Annotation
|
||||||
|
|
||||||
During this process the database automatically gets dropped (if it exists) and re-created.
|
* During this process the database automatically gets dropped (if it exists) and re-created
|
||||||
|
* The total storage space needed for this installation (w/o profiling data) is ≈10 GB
|
||||||
|
* The database space needed for this installation is ≈500 MB
|
||||||
|
* The runtime of the script is approx. 1h but can be slower depending on the hardware (slower CPU, hard drive vs SSD)
|
||||||
|
|
||||||
|
### Profiling
|
||||||
|
|
||||||
|
You maybe want to use the following command to run the install script instead in order to also generate a cachegrind output for memory and performance profiling:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
php -dxdebug.profiler_enable=1 -dxdebug.mode=develop,debug,profile -dxdebug.output_dir=/your/path demoSetup/setup.php
|
||||||
|
```
|
||||||
|
|
||||||
|
> This may use a lot of resources and storage space (≈15 GB of cachegrind data w/o trace data and ≈120 GB w/ trace data)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user