mirror of
https://github.com/RSS-Bridge/rss-bridge.git
synced 2025-02-03 17:01:00 +03:00
Add "For developers" section
parent
851faddd8c
commit
622beb3338
1 changed files with 20 additions and 0 deletions
20
For-developers.md
Normal file
20
For-developers.md
Normal file
|
@ -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!
|
Loading…
Add table
Reference in a new issue