summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-06-06 11:06:39 -0400
committerFrederic Guillot <fred@kanboard.net>2015-06-06 11:06:39 -0400
commitc87e1fbc33416e7b2f59b98c2ffed173958b3146 (patch)
tree10b37c00376cf5b0d9f20085817e068e7fbc59c0
parent5158fbc89c1c0b0ff1027b6833d32274bd31b1db (diff)
Update readme and list of contributors
-rw-r--r--CONTRIBUTORS.md83
-rw-r--r--README.markdown239
-rw-r--r--docs/index.markdown118
3 files changed, 216 insertions, 224 deletions
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
new file mode 100644
index 00000000..bbf22f3d
--- /dev/null
+++ b/CONTRIBUTORS.md
@@ -0,0 +1,83 @@
+Contributors
+============
+
+Original author and main developer: Frédéric Guillot (fguillot)
+
+Contributors:
+
+- Alex Butum
+- [Aleix Pol](https://github.com/aleixpol)
+- [Ashbike](https://github.com/ashbike)
+- [Ashish Kulkarni](https://github.com/ashkulz)
+- [Christian González](https://github.com/nerdoc)
+- [Chorgroup](https://github.com/chorgroup)
+- Claudio Lobo
+- [Cluxter](https://github.com/cluxter)
+- [Cmer](https://github.com/chncsu)
+- [Colin Williams](https://github.com/crwilliams)
+- [Crash5](https://github.com/crash5)
+- [Creador30](https://github.com/creador30)
+- [Cynthia Pereira](https://github.com/cynthiapereira)
+- [David-Norris](https://github.com/David-Norris)
+- [Draza (bdpsoft)](https://github.com/bdpsoft)
+- [Esteban Monge](https://github.com/EstebanMonge)
+- [Fengchao](https://github.com/fengchao)
+- [Floaltvater](https://github.com/floaltvater)
+- [Gavlepeter](https://github.com/gavlepeter)
+- [Hendrik Stocker](https://github.com/hendrik-stoker)
+- [Iterate From 0](https://github.com/freebsd-kanboard)
+- [Jan Dittrich](https://github.com/jdittrich)
+- [Janne Mäntyharju](https://github.com/JanneMantyharju)
+- [Jean-François Magnier](https://github.com/lefakir)
+- [Jesusaplsoft](https://github.com/jesusaplsoft)
+- [Karol J](https://github.com/dzudek)
+- [Kiswa](https://github.com/kiswa)
+- [Kralo](https://github.com/kralo)
+- [Lars Christian Schou](https://github.com/NegoZiatoR)
+- [Levlaz](https://github.com/levlaz)
+- [Lim Yuen Hoe](https://github.com/jasonmoofang)
+- [Manish Lad](https://github.com/manishlad)
+- [Mathgl67](https://github.com/mathgl67)
+- [Matthieu Keller](https://github.com/maggick)
+- [Mauro Mariño](https://github.com/moromarino)
+- [Maxime](https://github.com/EpocDotFr)
+- [mfoucrier](https://github.com/mfoucrier)
+- [Mgro](https://github.com/mgro)
+- [Michael Lüpkes](https://github.com/mluepkes)
+- [Mihailov Vasilievic Filho](https://github.com/mihailov-vf)
+- [Moraxy](https://github.com/moraxy)
+- [Nala Ginrut](https://github.com/NalaGinrut)
+- [Nekohayo](https://github.com/nekohayo)
+- [Nicolas Lœuillet](https://github.com/nicosomb)
+- [Norcnorc](https://github.com/norcnorc)
+- [Nramel](https://github.com/nramel)
+- [Null-Kelvin](https://github.com/Null-Kelvin)
+- [Oliver Bertuch](https://github.com/poikilotherm)
+- [Olivier Maridat](https://github.com/oliviermaridat)
+- [Oren Ben-Kiki](https://github.com/orenbenkiki)
+- Paolo Mainieri
+- [Peller Zoltan](https://github.com/PierP)
+- [Petja Touru](https://github.com/Petja)
+- [Piotr Zęgota](https://github.com/ZegalPL)
+- [Rafaelrossa](https://github.com/rafaelrossa)
+- [Raphaël Doursenaud](https://github.com/rdoursenaud)
+- [René Stoltenberg](https://github.com/rstoltenberg)
+- [Rzeka](https://github.com/rzeka)
+- [Sebastien Pacilly](https://github.com/spacilly)
+- [Sebastian Reese](https://github.com/ReeseSebastian)
+- [Semyon Novikov](https://github.com/semka)
+- [Sylvain Veyrié](https://github.com/turb)
+- [Timo](https://github.com/BlueTeck)
+- [Timotheus Pokorra](https://github.com/tpokorra)
+- [Tomáš Votruba](https://github.com/TomasVotruba)
+- [Toomyem](https://github.com/Toomyem)
+- [Tony G. Bolaño](https://github.com/tonybolanyo)
+- [Torsten](https://github.com/misterfu)
+- [Troloo](https://github.com/troloo)
+- [Typz](https://github.com/Typz)
+- [Vedovator](https://github.com/vedovator)
+- [Vladimir Babin](https://github.com/Chiliec)
+- [Ybarc](https://github.com/ybarc)
+- [Yuichi Murata](https://github.com/yuichi1004)
+
+There is also many people who have reported bugs or proposed awesome ideas. \ No newline at end of file
diff --git a/README.markdown b/README.markdown
index 2a477c4c..352cfe5b 100644
--- a/README.markdown
+++ b/README.markdown
@@ -11,6 +11,8 @@ Official website: <http://kanboard.net>
- Minimalist software, focus only on essential features (Less is more)
- Open source and self-hosted
- Super simple installation
+- Translated in 18 languages
+- [List of features are available on the website](http://kanboard.net/features)
[![Build Status](https://travis-ci.org/fguillot/kanboard.svg)](https://travis-ci.org/fguillot/kanboard)
@@ -18,32 +20,26 @@ Official website: <http://kanboard.net>
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
-Features
---------
-
-- Multiple boards/projects
-- Boards customization, rename/add/remove columns
-- Tasks with different colors, categories, sub-tasks, attachments, comments and Markdown support for the description
-- Automatic actions based on events
-- User management with a basic privileges separation (administrator or regular user)
-- Email notifications
-- External authentication: Google, GitHub, LDAP/ActiveDirectory and Reverse-Proxy
-- Webhooks to create tasks from an external software
-- A basic command line interface
-- Host anywhere (shared hosting, VPS, Raspberry Pi or localhost)
-- No external dependencies
-- **Super easy setup**, copy and paste files and you are done!
-- Translated in 18 languages (Brazilian, Chinese, Danish, Dutch, English, Finnish, French, German, Hungarian, Italian, Japanese, Polish, Russian, Serbian, Spanish, Swedish, Thai, Turkish)
-
Known bugs and feature requests
-------------------------------
-See Issues: <https://github.com/fguillot/kanboard/issues>
+- Bug tracker: <https://github.com/fguillot/kanboard/issues>
License
-------
-GNU Affero General Public License version 3: <http://www.gnu.org/licenses/agpl-3.0.txt>
+- GNU Affero General Public License version 3: <http://www.gnu.org/licenses/agpl-3.0.txt>
+
+Authors
+-------
+
+- Main developer: Frédéric Guillot (fguillot)
+- [List of contributors](CONTRIBUTORS.md)
+
+Documentation
+-------------
+
+- [Read the documentation](docs/index.markdown)
Related projects
----------------
@@ -54,208 +50,3 @@ Related projects
- [Trello import script by @matueranet](https://github.com/matueranet/kanboard-import-trello)
- [Chrome extension by Timo](https://chrome.google.com/webstore/detail/kanboard-quickmenu/akjbeplnnihghabpgcfmfhfmifjljneh?utm_source=chrome-ntp-icon), [Source code](https://github.com/BlueTeck/kanboard_chrome_extension)
- [Wunderlist To Kanboard script by EpocDotFr](https://github.com/EpocDotFr/WunderlistToKanboard)
-
-Documentation
--------------
-
-### Using Kanboard
-
-#### Introduction
-
-- [What is Kanban?](docs/what-is-kanban.markdown)
-- [Kanban vs Todo Lists and Scrum](docs/kanban-vs-todo-and-scrum.markdown)
-- [Usage examples](docs/usage-examples.markdown)
-
-#### Working with projects
-
-- [Creating projects](docs/creating-projects.markdown)
-- [Editing projects](docs/editing-projects.markdown)
-- [Sharing boards and tasks](docs/sharing-projects.markdown)
-- [Automatic actions](docs/automatic-actions.markdown)
-- [Project permissions](docs/project-permissions.markdown)
-- [Swimlanes](docs/swimlanes.markdown)
-- [Calendar](docs/calendar.markdown)
-- [Budget](docs/budget.markdown)
-- [Analytics](docs/analytics.markdown)
-
-#### Working with tasks
-
-- [Creating tasks](docs/creating-tasks.markdown)
-- [Adding screenshots](docs/screenshots.markdown)
-- [Task links](docs/task-links.markdown)
-- [Transitions](docs/transitions.markdown)
-- [Time tracking](docs/time-tracking.markdown)
-- [Recurring tasks](docs/recurring-tasks.markdown)
-- [Create tasks by email](docs/create-tasks-by-email.markdown)
-
-#### Working with users
-
-- [User management](docs/user-management.markdown)
-- [Hourly rate](docs/hourly-rate.markdown)
-- [Timetable](docs/timetable.markdown)
-- [Two factor authentication](docs/2fa.markdown)
-
-#### Settings
-
-- [Keyboard shortcuts](docs/keyboard-shortcuts.markdown)
-- [Application settings](docs/application-configuration.markdown)
-- [Project settings](docs/project-configuration.markdown)
-- [Board settings](docs/board-configuration.markdown)
-- [Calendar settings](docs/calendar-configuration.markdown)
-- [Link settings](docs/link-labels.markdown)
-- [Currency rate](docs/currency-rate.markdown)
-- [Config file](docs/config.markdown)
-
-### Integrations
-
-- [Bitbucket webhooks](docs/bitbucket-webhooks.markdown)
-- [Github webhooks](docs/github-webhooks.markdown)
-- [Gitlab webhooks](docs/gitlab-webhooks.markdown)
-- [Hipchat](docs/hipchat.markdown)
-- [Jabber](docs/jabber.markdown)
-- [Mailgun](docs/mailgun.markdown)
-- [Sendgrid](docs/sendgrid.markdown)
-- [Slack](docs/slack.markdown)
-- [Postmark](docs/postmark.markdown)
-- [iCalendar subscriptions](docs/ical.markdown)
-
-#### More
-
-- [Syntax guide](docs/syntax-guide.markdown)
-- [Frequently asked questions](docs/faq.markdown)
-
-### Technical details
-
-#### Installation
-
-- [Installation instructions](docs/installation.markdown)
-- [Upgrade Kanboard to a new version](docs/update.markdown)
-- [Installation on Ubuntu](docs/ubuntu-installation.markdown)
-- [Installation on Debian](docs/debian-installation.markdown)
-- [Installation on Centos](docs/centos-installation.markdown)
-- [Installation on FreeBSD](docs/freebsd-installation.markdown)
-- [Installation on Windows Server with IIS](docs/windows-iis-installation.markdown)
-- [Installation on Windows Server with Apache](docs/windows-apache-installation.markdown)
-- [Installation on Heroku](docs/heroku.markdown)
-- [Example with Nginx + HTTPS + SPDY + PHP-FPM](docs/nginx-ssl-php-fpm.markdown)
-
-#### Database
-
-- [Sqlite database management](docs/sqlite-database.markdown)
-- [How to use Mysql](docs/mysql-configuration.markdown)
-- [How to use Postgresql](docs/postgresql-configuration.markdown)
-
-#### Authentication
-
-- [LDAP authentication](docs/ldap-authentication.markdown)
-- [Google authentication](docs/google-authentication.markdown)
-- [GitHub authentication](docs/github-authentication.markdown)
-- [Reverse proxy authentication](docs/reverse-proxy-authentication.markdown)
-
-#### Developers and sysadmins
-
-- [Email configuration](docs/email-configuration.markdown)
-- [Command line interface](docs/cli.markdown)
-- [Json-RPC API](docs/api-json-rpc.markdown)
-- [Webhooks](docs/webhooks.markdown)
-- [Run Kanboard with Vagrant](docs/vagrant.markdown)
-- [Run Kanboard with Docker](docs/docker.markdown)
-
-### Contributors
-
-- [Contributor guide](docs/contributing.markdown)
-- [Translations](docs/translations.markdown)
-- [Coding standards](docs/coding-standards.markdown)
-- [Running tests](docs/tests.markdown)
-- [Build assets](docs/assets.markdown)
-
-The documentation is written in [Markdown](http://en.wikipedia.org/wiki/Markdown).
-If you want to improve the documentation, just send a pull-request.
-
-FAQ
----
-
-Go to the official website: <http://kanboard.net/faq>
-
-Authors
--------
-
-Original author: [Frédéric Guillot](http://fredericguillot.com/)
-
-Contributors:
-
-- Alex Butum
-- [Aleix Pol](https://github.com/aleixpol)
-- [Ashbike](https://github.com/ashbike)
-- [Ashish Kulkarni](https://github.com/ashkulz)
-- [Christian González](https://github.com/nerdoc)
-- [Chorgroup](https://github.com/chorgroup)
-- Claudio Lobo
-- [Cluxter](https://github.com/cluxter)
-- [Cmer](https://github.com/chncsu)
-- [Colin Williams](https://github.com/crwilliams)
-- [Crash5](https://github.com/crash5)
-- [Creador30](https://github.com/creador30)
-- [Cynthia Pereira](https://github.com/cynthiapereira)
-- [David-Norris](https://github.com/David-Norris)
-- [Draza (bdpsoft)](https://github.com/bdpsoft)
-- [Esteban Monge](https://github.com/EstebanMonge)
-- [Fengchao](https://github.com/fengchao)
-- [Floaltvater](https://github.com/floaltvater)
-- [Gavlepeter](https://github.com/gavlepeter)
-- [Hendrik Stocker](https://github.com/hendrik-stoker)
-- [Iterate From 0](https://github.com/freebsd-kanboard)
-- [Jan Dittrich](https://github.com/jdittrich)
-- [Janne Mäntyharju](https://github.com/JanneMantyharju)
-- [Jean-François Magnier](https://github.com/lefakir)
-- [Jesusaplsoft](https://github.com/jesusaplsoft)
-- [Karol J](https://github.com/dzudek)
-- [Kiswa](https://github.com/kiswa)
-- [Kralo](https://github.com/kralo)
-- [Lars Christian Schou](https://github.com/NegoZiatoR)
-- [Levlaz](https://github.com/levlaz)
-- [Lim Yuen Hoe](https://github.com/jasonmoofang)
-- [Manish Lad](https://github.com/manishlad)
-- [Mathgl67](https://github.com/mathgl67)
-- [Matthieu Keller](https://github.com/maggick)
-- [Mauro Mariño](https://github.com/moromarino)
-- [Maxime](https://github.com/EpocDotFr)
-- [mfoucrier](https://github.com/mfoucrier)
-- [Mgro](https://github.com/mgro)
-- [Michael Lüpkes](https://github.com/mluepkes)
-- [Mihailov Vasilievic Filho](https://github.com/mihailov-vf)
-- [Moraxy](https://github.com/moraxy)
-- [Nala Ginrut](https://github.com/NalaGinrut)
-- [Nekohayo](https://github.com/nekohayo)
-- [Nicolas Lœuillet](https://github.com/nicosomb)
-- [Norcnorc](https://github.com/norcnorc)
-- [Nramel](https://github.com/nramel)
-- [Null-Kelvin](https://github.com/Null-Kelvin)
-- [Oliver Bertuch](https://github.com/poikilotherm)
-- [Olivier Maridat](https://github.com/oliviermaridat)
-- [Oren Ben-Kiki](https://github.com/orenbenkiki)
-- Paolo Mainieri
-- [Peller Zoltan](https://github.com/PierP)
-- [Petja Touru](https://github.com/Petja)
-- [Piotr Zęgota](https://github.com/ZegalPL)
-- [Rafaelrossa](https://github.com/rafaelrossa)
-- [Raphaël Doursenaud](https://github.com/rdoursenaud)
-- [René Stoltenberg](https://github.com/rstoltenberg)
-- [Rzeka](https://github.com/rzeka)
-- [Sebastien Pacilly](https://github.com/spacilly)
-- [Sebastian Reese](https://github.com/ReeseSebastian)
-- [Semyon Novikov](https://github.com/semka)
-- [Sylvain Veyrié](https://github.com/turb)
-- [Timo](https://github.com/BlueTeck)
-- [Tomáš Votruba](https://github.com/TomasVotruba)
-- [Toomyem](https://github.com/Toomyem)
-- [Tony G. Bolaño](https://github.com/tonybolanyo)
-- [Torsten](https://github.com/misterfu)
-- [Troloo](https://github.com/troloo)
-- [Typz](https://github.com/Typz)
-- [Vedovator](https://github.com/vedovator)
-- [Vladimir Babin](https://github.com/Chiliec)
-- [Ybarc](https://github.com/ybarc)
-- [Yuichi Murata](https://github.com/yuichi1004)
-
-There is also many people who have reported bugs or proposed awesome ideas.
diff --git a/docs/index.markdown b/docs/index.markdown
new file mode 100644
index 00000000..75df4694
--- /dev/null
+++ b/docs/index.markdown
@@ -0,0 +1,118 @@
+Documentation
+=============
+
+Using Kanboard
+--------------
+
+### Introduction
+
+- [What is Kanban?](what-is-kanban.markdown)
+- [Kanban vs Todo Lists and Scrum](kanban-vs-todo-and-scrum.markdown)
+- [Usage examples](usage-examples.markdown)
+
+### Working with projects
+
+- [Creating projects](creating-projects.markdown)
+- [Editing projects](editing-projects.markdown)
+- [Sharing boards and tasks](sharing-projects.markdown)
+- [Automatic actions](automatic-actions.markdown)
+- [Project permissions](project-permissions.markdown)
+- [Swimlanes](swimlanes.markdown)
+- [Calendar](calendar.markdown)
+- [Budget](budget.markdown)
+- [Analytics](analytics.markdown)
+
+### Working with tasks
+
+- [Creating tasks](creating-tasks.markdown)
+- [Adding screenshots](screenshots.markdown)
+- [Task links](task-links.markdown)
+- [Transitions](transitions.markdown)
+- [Time tracking](time-tracking.markdown)
+- [Recurring tasks](recurring-tasks.markdown)
+- [Create tasks by email](create-tasks-by-email.markdown)
+
+### Working with users
+
+- [User management](user-management.markdown)
+- [Hourly rate](hourly-rate.markdown)
+- [Timetable](timetable.markdown)
+- [Two factor authentication](2fa.markdown)
+
+### Settings
+
+- [Keyboard shortcuts](keyboard-shortcuts.markdown)
+- [Application settings](application-configuration.markdown)
+- [Project settings](project-configuration.markdown)
+- [Board settings](board-configuration.markdown)
+- [Calendar settings](calendar-configuration.markdown)
+- [Link settings](link-labels.markdown)
+- [Currency rate](currency-rate.markdown)
+- [Config file](config.markdown)
+
+### Integrations
+
+- [Bitbucket webhooks](bitbucket-webhooks.markdown)
+- [Github webhooks](github-webhooks.markdown)
+- [Gitlab webhooks](gitlab-webhooks.markdown)
+- [Hipchat](hipchat.markdown)
+- [Jabber](jabber.markdown)
+- [Mailgun](mailgun.markdown)
+- [Sendgrid](sendgrid.markdown)
+- [Slack](slack.markdown)
+- [Postmark](postmark.markdown)
+- [iCalendar subscriptions](ical.markdown)
+- [Json-RPC API](api-json-rpc.markdown)
+- [Webhooks](webhooks.markdown)
+
+### More
+
+- [Command line interface](cli.markdown)
+- [Syntax guide](syntax-guide.markdown)
+- [Frequently asked questions](faq.markdown)
+
+Technical details
+-----------------
+
+### Installation
+
+- [Installation instructions](installation.markdown)
+- [Upgrade Kanboard to a new version](update.markdown)
+- [Installation on Ubuntu](ubuntu-installation.markdown)
+- [Installation on Debian](debian-installation.markdown)
+- [Installation on Centos](centos-installation.markdown)
+- [Installation on FreeBSD](freebsd-installation.markdown)
+- [Installation on Windows Server with IIS](windows-iis-installation.markdown)
+- [Installation on Windows Server with Apache](windows-apache-installation.markdown)
+- [Installation on Heroku](heroku.markdown)
+- [Example with Nginx + HTTPS + SPDY + PHP-FPM](nginx-ssl-php-fpm.markdown)
+- [Run Kanboard with Docker](docker.markdown)
+
+### Configuration
+
+- [Email configuration](email-configuration.markdown)
+
+### Database
+
+- [Sqlite database management](sqlite-database.markdown)
+- [How to use Mysql](mysql-configuration.markdown)
+- [How to use Postgresql](postgresql-configuration.markdown)
+
+### Authentication
+
+- [LDAP authentication](ldap-authentication.markdown)
+- [Google authentication](google-authentication.markdown)
+- [GitHub authentication](github-authentication.markdown)
+- [Reverse proxy authentication](reverse-proxy-authentication.markdown)
+
+### Contributors
+
+- [Contributor guide](contributing.markdown)
+- [Translations](translations.markdown)
+- [Coding standards](coding-standards.markdown)
+- [Running tests](tests.markdown)
+- [Build assets](assets.markdown)
+- [Run Kanboard with Vagrant](vagrant.markdown)
+
+The documentation is written in [Markdown](http://en.wikipedia.org/wiki/Markdown).
+If you want to improve the documentation, just send a pull-request.