com web/bugs: Add directory structure to README: README.md

Commit: 001a1dbe21cf6b61c6cc8d45afaa2d5c8cb7c6e7 Author: Peter Kokot <peterkokot@gmail.com> Mon, 10 Dec 2018 02:20:20 +0100 Parents: be3c259ecaae28db43a3a8c30338a876f112e36e Branches: master Link: http://git.php.net/?p=web/bugs.git;a=commitdiff;h=001a1dbe21cf6b61c6cc8d45afaa2d5c8cb7c6e7 Log: Add directory structure to README Changed paths: M README.md Diff: diff --git a/README.md b/README.md index 7e353d0..799e64b 100644 --- a/README.md +++ b/README.md @@ -37,3 +37,35 @@ installing dependencies by running phpunit: ```bash phpunit ``` + +## Directory structure + +Source code of this application is structured in the following directories: + +```bash +<web-bugs>/ + ├─ .git/ # Git configuration and source directory + └─ include/ # Application helper functions and configuration + ├─ prepend.php # Autoloader, DB connection, container, app initialization + └─ ... + └─ scripts/ # Command line development tools and scripts + ├─ cron/ # Various systems scripts to run periodically on the server + └─ ... + ├─ sql/ # Database schema and fixtures + ├─ src/ # Application source code classes + ├─ templates/ # Application templates + ├─ tests/ # Application automated tests + ├─ uploads/ # Uploaded patch files + ├─ vendor/ # Dependencies generated by Composer + └─ www/ # Publicly accessible directory for online bugs.php.net + ├─ css/ # Stylesheets + ├─ images/ # Images + ├─ js/ # JavaScript assets + └─ ... + ├─ composer.json # Composer dependencies and project meta definition + ├─ composer.lock # Dependencies versions currently installed + ├─ local_config.php # Application configuration + ├─ local_config.php.sample # Distributed configuration example + ├─ phpunit.xml.dist # PHPUnit's default XML configuration + └─ ... +```