improve/README.md

53 lines
1.2 KiB
Markdown

# README
[![Release][releases-shield]][releases]
[![Issues][issues-shield]][issues]
[![License][license-shield]](LICENSE)
[![Dotclear version](https://img.shields.io/badge/dotclear-2.19-blue)](https://fr.dotclear.org/download)
## WHAT IS IMPROVE ?
**improve** is a plugin for the open-source
web publishing software called Dotclear.
It helps dev to clean up plugin or theme before publishing code.
* Open to third party plugin
* Easy and fast to use
* Esay and fast to extend
## REQUIREMENTS
**improve** requires:
* admin permission
* Dotclear 2.19
## USAGE
First install **improve**, manualy from a zip package or from
Dotaddict repository. (See Dotclear's documentation to know how do this)
Manage tools from sidebar plugin menu **improve**.
Configure actions. Select actions and module to work with, then click fix.
## DEFAULT FEATURES
* Fix Tab to Space
* Fix End Of Line
* Fix End Of File on php files
* Fix header (phpdoc) on php files
* _Fix license old style bloc (removed)_
* Fix dcstore.xml file
* Create package
## NEXT
* Scan for missing files
* Scan for deprecated function
* ...
## MORE
* License : GNU GPL v2
* Source & contribution : [GitHub Page](https://github.com/JcDenis/improve)