From 58409726af5556f5ca17923cd0ed0991f8923aaa Mon Sep 17 00:00:00 2001 From: LogMANOriginal Date: Sat, 13 Aug 2016 20:14:34 +0200 Subject: [PATCH] Add "Folder structure" section --- Folder-structure.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 Folder-structure.md diff --git a/Folder-structure.md b/Folder-structure.md new file mode 100644 index 0000000..0d8788a --- /dev/null +++ b/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](Screenshots#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