From 622beb3338e9b90a6dd8de97683ab983aa491469 Mon Sep 17 00:00:00 2001 From: LogMANOriginal Date: Sat, 13 Aug 2016 19:24:46 +0200 Subject: [PATCH] Add "For developers" section --- For-developers.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 For-developers.md diff --git a/For-developers.md b/For-developers.md new file mode 100644 index 0000000..346f62a --- /dev/null +++ b/For-developers.md @@ -0,0 +1,20 @@ +This area is intended for developers who decide to contribute to **RSS-Bridge** which is primarily written in `PHP` with some aspects of `HTTP` and `CSS`. + +# Repository structure + +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**) + +# Debug mode + +To enable debug mode (disabling cache and enabling error reporting), create an empty file named `DEBUG` in the root directory (next to `index.php`) + +**Notice:** The whitelist still applies! \ No newline at end of file