diff options
Diffstat (limited to 'docs/04_For_Developers/03_Folder_structure.md')
| -rw-r--r-- | docs/04_For_Developers/03_Folder_structure.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/04_For_Developers/03_Folder_structure.md b/docs/04_For_Developers/03_Folder_structure.md new file mode 100644 index 00000000..27f905c9 --- /dev/null +++ b/docs/04_For_Developers/03_Folder_structure.md @@ -0,0 +1,10 @@ +The repository contains a few folders that make up **RSS-Bridge**. Here is a brief description of what you can expect to find where: + +Folder | Description +-------|------------ +[`bridges/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/bridges) | Contains all bridges that are currently supported by **RSS-Bridge**. Each file represents one Bridge that is displayed on the [Welcome screen](../01_General/04_Screenshots.md#welcome-screen) of **RSS-Bridge** +[`caches/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/caches) | Contains all cache types for **RSS-Bridge**. +[`css/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/css) | Contains all [Cascading Style Sheets](https://en.wikipedia.org/wiki/Cascading_Style_Sheets) for **RSS-Bridge** +[`formats/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/formats) | Contains all export formats for **RSS-Bridge**. +[`lib/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/lib) | Contains the core API of **RSS-Bridge**. +[`vendor/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/vendor) | Contains vendor specific files to support **RSS-Bridge**. Development of all files in this folder must be done in the vendor specific repository (not part of **RSS-Bridge**)
\ No newline at end of file |