diff options
author | VirtualTam <virtualtam@flibidi.net> | 2018-02-14 21:58:41 +0100 |
---|---|---|
committer | VirtualTam <virtualtam@flibidi.net> | 2018-02-14 21:58:41 +0100 |
commit | 4c1bcd8b254e3376ee1a6d1108a0e56b550f28db (patch) | |
tree | 225691d3419b66e70a183f5e5d76d02e1e166ad8 | |
parent | 8b48e36594394e367cbb33c7ad1a679ea57c374d (diff) | |
download | Shaarli-4c1bcd8b254e3376ee1a6d1108a0e56b550f28db.tar.gz Shaarli-4c1bcd8b254e3376ee1a6d1108a0e56b550f28db.tar.zst Shaarli-4c1bcd8b254e3376ee1a6d1108a0e56b550f28db.zip |
doc: update Directory Structure
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
-rw-r--r-- | doc/md/Directory-structure.md | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/doc/md/Directory-structure.md b/doc/md/Directory-structure.md index eb50965b..937a076d 100644 --- a/doc/md/Directory-structure.md +++ b/doc/md/Directory-structure.md | |||
@@ -1,4 +1,4 @@ | |||
1 | TODO: This page is out of date | 1 | ## Directory structure |
2 | 2 | ||
3 | Here is the directory structure of Shaarli and the purpose of the different files: | 3 | Here is the directory structure of Shaarli and the purpose of the different files: |
4 | 4 | ||
@@ -6,10 +6,16 @@ Here is the directory structure of Shaarli and the purpose of the different file | |||
6 | index.php # Main program | 6 | index.php # Main program |
7 | application/ # Shaarli classes | 7 | application/ # Shaarli classes |
8 | ├── LinkDB.php | 8 | ├── LinkDB.php |
9 | |||
10 | ... | ||
11 | |||
9 | └── Utils.php | 12 | └── Utils.php |
10 | tests/ # Shaarli unitary & functional tests | 13 | tests/ # Shaarli unitary & functional tests |
11 | ├── LinkDBTest.php | 14 | ├── LinkDBTest.php |
12 | ├── utils # utilities to ease testing | 15 | |
16 | ... | ||
17 | |||
18 | ├── utils # utilities to ease testing | ||
13 | │ └── ReferenceLinkDB.php | 19 | │ └── ReferenceLinkDB.php |
14 | └── UtilsTest.php | 20 | └── UtilsTest.php |
15 | COPYING # Shaarli license | 21 | COPYING # Shaarli license |
@@ -18,17 +24,18 @@ Here is the directory structure of Shaarli and the purpose of the different file | |||
18 | ├── blazy.* # picture wall lazy image loading library | 24 | ├── blazy.* # picture wall lazy image loading library |
19 | ├── shaarli.css, reset.css # Shaarli stylesheet. | 25 | ├── shaarli.css, reset.css # Shaarli stylesheet. |
20 | ├── qr.* # qr code generation library | 26 | ├── qr.* # qr code generation library |
21 | └──rain.tpl.class.php # RainTPL templating library | 27 | └── rain.tpl.class.php # RainTPL templating library |
22 | tpl/ # RainTPL templates for Shaarli. They are used to build the pages. | ||
23 | images/ # Images and icons used in Shaarli | 28 | images/ # Images and icons used in Shaarli |
24 | data/ # data storage: bookmark database, configuration, logs, banlist… | 29 | data/ # data storage: bookmark database, configuration, logs, banlist... |
25 | ├── config.php # Shaarli configuration (login, password, timezone, title…) | 30 | ├── config.json.php # Shaarli configuration (login, password, timezone, title...) |
26 | ├── datastore.php # Your link database (compressed). | 31 | ├── datastore.php # Your link database (compressed). |
27 | ├── ipban.php # IP address ban system data | 32 | ├── ipban.php # IP address ban system data |
28 | ├── lastupdatecheck.txt # Update check timestamp file | 33 | ├── lastupdatecheck.txt # Update check timestamp file |
29 | └──log.txt # login/IPban log. | 34 | └── log.txt # login/IPban log. |
35 | tpl/ # RainTPL templates for Shaarli. They are used to build the pages. | ||
30 | cache/ # thumbnails cache | 36 | cache/ # thumbnails cache |
31 | # This directory is automatically created. You can erase it anytime you want. | 37 | # This directory is automatically created. You can erase it anytime you want. |
32 | tmp/ # Temporary directory for compiled RainTPL templates. | 38 | tmp/ # Temporary directory for compiled RainTPL templates. |
33 | # This directory is automatically created. You can erase it anytime you want. | 39 | # This directory is automatically created. You can erase it anytime you want. |
40 | vendor/ # Third-party dependencies. This directory is created by Composer | ||
34 | ``` | 41 | ``` |