| 1 | # README |
|---|
| 2 | |
|---|
| 3 | ## WHAT IS DOTCLEAR ? |
|---|
| 4 | |
|---|
| 5 | Dotclear is an open-source web publishing software. |
|---|
| 6 | Take control over your blog! |
|---|
| 7 | |
|---|
| 8 | Dotclear project's purpose is to provide a user-friendly |
|---|
| 9 | tool allowing anyone to publish on the web, regardless of |
|---|
| 10 | their technical skills. |
|---|
| 11 | |
|---|
| 12 | ### Features: |
|---|
| 13 | * Easy publication |
|---|
| 14 | * Fully customizable theme |
|---|
| 15 | * User-friendly administration |
|---|
| 16 | * Flexible template system |
|---|
| 17 | * Media management |
|---|
| 18 | * Choose from several editing syntax (wiki, markdown, textile or directly in wysiwyg) |
|---|
| 19 | * Flexible comment system |
|---|
| 20 | * Built-in antispam |
|---|
| 21 | * Localization |
|---|
| 22 | * Presentation widgets |
|---|
| 23 | * Themes and plugins |
|---|
| 24 | * Pages |
|---|
| 25 | * Tags and categories |
|---|
| 26 | * Automated installation |
|---|
| 27 | * Support for several database types |
|---|
| 28 | * Multiblog |
|---|
| 29 | * Multi-user with permissions |
|---|
| 30 | * Standards compliant |
|---|
| 31 | * Accessible |
|---|
| 32 | * Importing / exporting |
|---|
| 33 | * Naturally optimized for search engines |
|---|
| 34 | * Syndication feeds |
|---|
| 35 | * Complete trackback support |
|---|
| 36 | * Full Unicode support |
|---|
| 37 | * XML/RPC client support |
|---|
| 38 | * Extensible |
|---|
| 39 | * Performance and scalability |
|---|
| 40 | * Twice free |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | ## REQUIREMENTS |
|---|
| 44 | |
|---|
| 45 | In order to run Dotclear you need: |
|---|
| 46 | |
|---|
| 47 | * A web server (Apache, Cherokee, Nginx, lighttpd, etc.) |
|---|
| 48 | * PHP 5.6 with the following modules: |
|---|
| 49 | * mbstring |
|---|
| 50 | * iconv |
|---|
| 51 | * simplexml |
|---|
| 52 | * mysql, mysqli, postgresql or sqlite |
|---|
| 53 | * A database server (MySQL or PostgreSQL) or SQLite. |
|---|
| 54 | |
|---|
| 55 | |
|---|
| 56 | ## INSTALLATION |
|---|
| 57 | |
|---|
| 58 | ### Automatic installation |
|---|
| 59 | The easiest way to install the blog engine is automatic installation. |
|---|
| 60 | Download the [one minute install file][1], upload it to your web space. Then open it in your favorite browser. You'll only have to follow the instructions on screen. See the [documentation][2] for more information. |
|---|
| 61 | |
|---|
| 62 | ### Standard installation. |
|---|
| 63 | You need to download [Dotclear archive][3], extract it then upload your files to your web space using an FTP client. |
|---|
| 64 | Then open your favorite browser and go to http://your.host.name/dotclear/admin/install/. A message alerts you that you haven't got a configuration file and offers to run the wizard. Click this link. |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | ## DOCUMENTATION |
|---|
| 68 | Still unsure if you want to move? A "[guided tour][4]" is what you need. |
|---|
| 69 | |
|---|
| 70 | Dotclear is fully documented: |
|---|
| 71 | |
|---|
| 72 | * If you have moved in already, the [User Manual][5] is there for you. |
|---|
| 73 | * The managers will turn to the [Administration Guide][6]. |
|---|
| 74 | * Decorators and craftsmen will surely enjoy reading the [Developer and designer resources][7]. |
|---|
| 75 | |
|---|
| 76 | Dotclear documentation uses a wiki. Feel free to contribute. |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | ## License |
|---|
| 80 | |
|---|
| 81 | Copyright Olivier Meunier & Association Dotclear |
|---|
| 82 | |
|---|
| 83 | GPL-2.0-only (https://www.gnu.org/licenses/gpl-2.0.html) |
|---|
| 84 | |
|---|
| 85 | This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. |
|---|
| 86 | |
|---|
| 87 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. |
|---|
| 88 | |
|---|
| 89 | You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | CONTRIBUTING |
|---|
| 93 | ------------ |
|---|
| 94 | Dotclear is an open source project. If you'd like to contribute, please read the [CONTRIBUTING file](CONTRIBUTING.md). |
|---|
| 95 | You can submit a pull request, or feel free to use any other way you'd prefer. |
|---|
| 96 | |
|---|
| 97 | Repositories: |
|---|
| 98 | ------------- |
|---|
| 99 | https://git.dotclear.org/dotclear/ (official) |
|---|
| 100 | https://github.com/dotclear/dotclear (Github) |
|---|
| 101 | |
|---|
| 102 | |
|---|
| 103 | [1]: http://download.dotclear.org/loader/dotclear-loader.php |
|---|
| 104 | [2]: http://dotclear.org/documentation/2.0/admin/install |
|---|
| 105 | [3]: http://dotclear.org/download |
|---|
| 106 | [4]: http://dotclear.org/documentation/2.0/overview/tour |
|---|
| 107 | [5]: http://dotclear.org/documentation/2.0/usage |
|---|
| 108 | [6]: http://dotclear.org/documentation/2.0/admin |
|---|
| 109 | [7]: http://dotclear.org/documentation/2.0/resources |
|---|
| 110 | |
|---|
