From 0daa6d3f7b36a7841fc44056e62af922a20a4dd7 Mon Sep 17 00:00:00 2001 From: Lauri Ojansivu Date: Sat, 10 Nov 2018 02:41:27 +0200 Subject: Update readme for clarity. --- README.md | 44 +++++++++++++++++++++++++++++++------------- 1 file changed, 31 insertions(+), 13 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 54804197..2f72e5c5 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,30 @@ # Wekan -## Stable +## [Translate Wekan at Transifex](https://transifex.com/wekan/wekan) -- master+devel branch. At release, devel is merged to master. -- Receives fixes and features that have been tested at edge that they work. -- If you want automatic updates, [use Snap](https://github.com/wekan/wekan-snap/wiki/Install). -- If you want to test before update, [use Docker quay.io release tags](https://github.com/wekan/wekan/wiki/Docker). +Translations to non-English languages are accepted only at [Transifex](https://transifex.com/wekan/wekan) using webbrowser. +New English strings of new features can be added as PRs to edge branch file wekan/i18n/en.i18n.json . -## Edge +## [Wekan feature requests and bugs](https://github.com/wekan/wekan/issues) -- edge branch. All new fixes and features are added to here first. [Testing Edge](https://github.com/wekan/wekan-snap/wiki/Snap-Developer-Docs). +Please add most of your questions as GitHub issue: [Wekan feature requests and bugs](https://github.com/wekan/wekan/issues). +It's better than at chat where details get lost when chat scrolls up. -[![Translate Wekan at Transifex](https://img.shields.io/badge/Translate%20Wekan-at%20Transifex-brightgreen.svg "Freenode IRC")](https://transifex.com/wekan/wekan) +## Chat -[![Wekan Vanila Chat][vanila_badge]][vanila_chat] +[![Wekan Vanila Chat][vanila_badge]][vanila_chat] - Most Wekan community and developers are here at #wekan chat channel. +Use webbrowser to register, and after that you can also alternatively use mobile app Rocket.Chat by Rocket.Chat with +address https://chat.vanila.io and same username and password. + +[IRC FAQ - ANSWERS TO IRC QUESTIONS, READ BEFORE ASKING ANYTHING AT IRC](https://github.com/wekan/wekan/wiki/IRC-FAQ) [![IRC #wekan](https://img.shields.io/badge/IRC%20%23wekan-on%20Freenode-brightgreen.svg "Freenode IRC")](http://webchat.freenode.net?channels=%23wekan&uio=d4) +## FAQ + +**NOTE**: +- Please read the [FAQ](https://github.com/wekan/wekan/wiki/FAQ) first +- Please don't feed the trolls and spammers that are mentioned in the FAQ :) + [![Contributors](https://img.shields.io/github/contributors/wekan/wekan.svg "Contributors")](https://github.com/wekan/wekan/graphs/contributors) [![Docker Repository on Quay](https://quay.io/repository/wekan/wekan/status "Docker Repository on Quay")](https://quay.io/repository/wekan/wekan) [![Docker Hub container status](https://img.shields.io/docker/build/wekanteam/wekan.svg "Docker Hub container status")](https://hub.docker.com/r/wekanteam/wekan) @@ -26,9 +35,7 @@ [![Project Dependencies](https://david-dm.org/wekan/wekan.svg "Project Dependencies")](https://david-dm.org/wekan/wekan) [![Code analysis at Open Hub](https://img.shields.io/badge/code%20analysis-at%20Open%20Hub-brightgreen.svg "Code analysis at Open Hub")](https://www.openhub.net/p/wekan) -**NOTE**: -- Please read the [FAQ](https://github.com/wekan/wekan/wiki/FAQ) first -- Please don't feed the trolls and spammers that are mentioned in the FAQ :) +## About Wekan Wekan is an completely [Open Source][open_source] and [Free software][free_software] collaborative kanban board application with MIT license. @@ -42,7 +49,7 @@ that by providing one-click installation on various platforms. - [Features][features]: Wekan has real-time user interface. Not all features are implemented, yet. - [Platforms][platforms]: Wekan supports many platforms and plan is to add more. This will be the first place to look if you want to **install** it, test out and learn more in depth. - [Integrations][integrations]: Current possible integrations and future plans. -- [Team](https://github.com/wekan/wekan/wiki/Team): The people who spends their time and make wekan into what it is right now. +- [Team](https://github.com/wekan/wekan/wiki/Team): The people who spends their time and make Wekan into what it is right now. ## Roadmap @@ -71,6 +78,17 @@ If you want to know what is going on exactly this moment, you can check out the [![Screenshot of Wekan][screenshot_wefork]][roadmap_wefork] +## Stable + +- master+devel branch. At release, devel is merged to master. +- Receives fixes and features that have been tested at edge that they work. +- If you want automatic updates, [use Snap](https://github.com/wekan/wekan-snap/wiki/Install). +- If you want to test before update, [use Docker quay.io release tags](https://github.com/wekan/wekan/wiki/Docker). + +## Edge + +- edge branch. All new fixes and features are added to here first. [Testing Edge](https://github.com/wekan/wekan-snap/wiki/Snap-Developer-Docs). + ## License Wekan is released under the very permissive [MIT license](LICENSE), and made -- cgit v1.2.3-1-g7c22 From 16d925e588fa4e1a6422a08b9ef0b384fe4e255e Mon Sep 17 00:00:00 2001 From: Lauri Ojansivu Date: Sat, 10 Nov 2018 02:47:01 +0200 Subject: Reorganize readme. --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2f72e5c5..5899a54d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,14 @@ -# Wekan +# Wekan - Open Source kanban + +[![Contributors](https://img.shields.io/github/contributors/wekan/wekan.svg "Contributors")](https://github.com/wekan/wekan/graphs/contributors) +[![Docker Repository on Quay](https://quay.io/repository/wekan/wekan/status "Docker Repository on Quay")](https://quay.io/repository/wekan/wekan) +[![Docker Hub container status](https://img.shields.io/docker/build/wekanteam/wekan.svg "Docker Hub container status")](https://hub.docker.com/r/wekanteam/wekan) +[![Docker Hub pulls](https://img.shields.io/docker/pulls/wekanteam/wekan.svg "Docker Hub Pulls")](https://hub.docker.com/r/wekanteam/wekan) +[![Wekan Build Status][travis_badge]][travis_status] +[![Codacy Badge](https://api.codacy.com/project/badge/Grade/02137ecec4e34c5aa303f57637196a93 "Codacy Badge")](https://www.codacy.com/app/xet7/wekan?utm_source=github.com&utm_medium=referral&utm_content=wekan/wekan&utm_campaign=Badge_Grade) +[![Code Climate](https://codeclimate.com/github/wekan/wekan/badges/gpa.svg "Code Climate")](https://codeclimate.com/github/wekan/wekan) +[![Project Dependencies](https://david-dm.org/wekan/wekan.svg "Project Dependencies")](https://david-dm.org/wekan/wekan) +[![Code analysis at Open Hub](https://img.shields.io/badge/code%20analysis-at%20Open%20Hub-brightgreen.svg "Code analysis at Open Hub")](https://www.openhub.net/p/wekan) ## [Translate Wekan at Transifex](https://transifex.com/wekan/wekan) @@ -25,16 +35,6 @@ address https://chat.vanila.io and same username and password. - Please read the [FAQ](https://github.com/wekan/wekan/wiki/FAQ) first - Please don't feed the trolls and spammers that are mentioned in the FAQ :) -[![Contributors](https://img.shields.io/github/contributors/wekan/wekan.svg "Contributors")](https://github.com/wekan/wekan/graphs/contributors) -[![Docker Repository on Quay](https://quay.io/repository/wekan/wekan/status "Docker Repository on Quay")](https://quay.io/repository/wekan/wekan) -[![Docker Hub container status](https://img.shields.io/docker/build/wekanteam/wekan.svg "Docker Hub container status")](https://hub.docker.com/r/wekanteam/wekan) -[![Docker Hub pulls](https://img.shields.io/docker/pulls/wekanteam/wekan.svg "Docker Hub Pulls")](https://hub.docker.com/r/wekanteam/wekan) -[![Wekan Build Status][travis_badge]][travis_status] -[![Codacy Badge](https://api.codacy.com/project/badge/Grade/02137ecec4e34c5aa303f57637196a93 "Codacy Badge")](https://www.codacy.com/app/xet7/wekan?utm_source=github.com&utm_medium=referral&utm_content=wekan/wekan&utm_campaign=Badge_Grade) -[![Code Climate](https://codeclimate.com/github/wekan/wekan/badges/gpa.svg "Code Climate")](https://codeclimate.com/github/wekan/wekan) -[![Project Dependencies](https://david-dm.org/wekan/wekan.svg "Project Dependencies")](https://david-dm.org/wekan/wekan) -[![Code analysis at Open Hub](https://img.shields.io/badge/code%20analysis-at%20Open%20Hub-brightgreen.svg "Code analysis at Open Hub")](https://www.openhub.net/p/wekan) - ## About Wekan Wekan is an completely [Open Source][open_source] and [Free software][free_software] -- cgit v1.2.3-1-g7c22 From 644e2c334f5598e89766ac21a9472339db812812 Mon Sep 17 00:00:00 2001 From: Lauri Ojansivu Date: Sat, 10 Nov 2018 03:36:26 +0200 Subject: Fix IRC link ;) --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5899a54d..e57a63e9 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,7 @@ It's better than at chat where details get lost when chat scrolls up. Use webbrowser to register, and after that you can also alternatively use mobile app Rocket.Chat by Rocket.Chat with address https://chat.vanila.io and same username and password. -[IRC FAQ - ANSWERS TO IRC QUESTIONS, READ BEFORE ASKING ANYTHING AT IRC](https://github.com/wekan/wekan/wiki/IRC-FAQ) -[![IRC #wekan](https://img.shields.io/badge/IRC%20%23wekan-on%20Freenode-brightgreen.svg "Freenode IRC")](http://webchat.freenode.net?channels=%23wekan&uio=d4) +[Wekan IRC](https://github.com/wekan/wekan/wiki/IRC-FAQ) ## FAQ -- cgit v1.2.3-1-g7c22 From 329471e7e38bee8ba7def9910e6bc1b6a1f1d42e Mon Sep 17 00:00:00 2001 From: Lauri Ojansivu Date: Sat, 10 Nov 2018 04:12:56 +0200 Subject: Fix typo. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index e57a63e9..02caa7ea 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ It's better than at chat where details get lost when chat scrolls up. Use webbrowser to register, and after that you can also alternatively use mobile app Rocket.Chat by Rocket.Chat with address https://chat.vanila.io and same username and password. -[Wekan IRC](https://github.com/wekan/wekan/wiki/IRC-FAQ) +[Wekan IRC FAQ](https://github.com/wekan/wekan/wiki/IRC-FAQ) ## FAQ -- cgit v1.2.3-1-g7c22