Add code style section

rugk 2016-07-19 18:03:26 +02:00
parent 0c9e60be7b
commit aa48c7407c

@ -1,5 +1,13 @@
This fork of the original PrivateBin of Sebsauvage was refactored into an object oriented MVC structure. The `index.php` only includes an autoloader and starts the application by instancing a `privatebin` object.
## Code Style
To make it easy for you to adopt our code style, we provide you some configuration files for different tools. You just have to install the necessary tools in your IDE and they should use our configuration files automatically.
* Basic style: [editorconfig](http://editorconfig.org/)
* JavaScript: [ESLint](https://github.com/PrivateBin/PrivateBin/blob/master/.eslintrc)
* CSS: [CSSLint](https://github.com/CSSLint/csslint)
## Structure
The main code or **controller** is found in `lib/privatebin.php`.