Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/deck.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulius Haertl <jus@bitgrid.net>2017-01-18 21:08:49 +0300
committerJulius Haertl <jus@bitgrid.net>2017-01-19 11:41:22 +0300
commit7e123123f08b442e1f4678c6ea63e611540ed698 (patch)
tree7853fa7db534343c54ab1eef40faffdf2c92dc99 /README.md
parenta7c5f7987dfaed5a2311935678570db9b87a274b (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md56
1 files changed, 30 insertions, 26 deletions
diff --git a/README.md b/README.md
index a949a897..88cf73e6 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,34 @@
# Deck
-Deck is a kanban style project and personal management tool integrated with OwnCloud.
+[![Build Status](https://travis-ci.com/juliushaertl/deck-dev.svg?token=6auunhHMRyx7p3n8fzxZ&branch=master)](https://travis-ci.com/juliushaertl/deck-dev) [![CodeCov](https://codecov.io/github/juliushaertl/deck-dev/coverage.svg?branch=master)](https://codecov.io/github/juliushaertl/deck-dev) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/juliushaertl/apporder/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/juliushaertl/apporder/?branch=master) [![GitHub license](https://img.shields.io/badge/license-AGPLv3-blue.svg)](https://raw.githubusercontent.com/juliushaertl/apporder/master/LICENSE)
-![Deck - Board Overview](https://bitgrid.net/~jus/deck.png)
+Deck is a kanban style project and personal management tool integrated with Nextcloud.
+
+- :inbox_tray: Add your tasks to cards and put them in order
+- :page_facing_up: Write down additional notes in markdown
+- :busts_in_silhouette: Share with your team, friends or family
+- :rocket: Get your project organized
+
+![Deck - Manage cards on your board](https://bitgrid.net/~jus/deck.png)
+
+:boom: This is still alpha software: it may not be stable enough for production
+
+### Planned features
+
+- :file_folder: Attach files directly from your Nextcloud
+- :earth_africa: Share boards with the public
+- :calendar: Integration with Nextcloud calendar and other apps
+- :speech_balloon: Comments integration
+- :exclamation: Checkout the project milestones for more ...
## Installation/Update
+This app is supposed to work on Nextcloud version 11 or later.
+
+### Install latest release
+
+Grab the latest release over here, extract it to your Nextcloud apps folder and enable the app.
+
### Install from git
If you want to run the latest development version from git source, you need to clone the repo to your apps folder:
@@ -16,21 +39,19 @@ cd deck
make
```
-Please make sure you have installed the following dependencies:
-* make
-* which
-* tar: for building the archive
-* curl: used if phpunit and composer are not installed to fetch them from the web
-* npm: for building and testing everything JS, only required if a package.json is placed inside the **js/** folder
+Please make sure you have installed the following dependencies: `make, which, tar, npm, curl`
## Developing
### PHP
+Nothing to prepare, just dig into the code.
+
### JavaScript
-Run javascript watch ```make watch```
+Install dependencies with ```make dev-setup```
+Run javascript watch ```make watch```
## Building the app
@@ -38,23 +59,6 @@ The app can be built by using the provided Makefile by running:
make
-This requires the following things to be present:
-* make
-* which
-* tar: for building the archive
-* curl: used if phpunit and composer are not installed to fetch them from the web
-* npm: for building and testing everything JS, only required if a package.json is placed inside the **js/** folder
-
-The make command will install or update Composer dependencies if a composer.json is present and also **npm run build** if a package.json is present in the **js/** folder. The npm **build** script should use local paths for build systems and package managers, so people that simply want to build the app won't need to install npm libraries globally, e.g.:
-
-**package.json**:
-```json
-"scripts": {
- "test": "node node_modules/gulp-cli/bin/gulp.js karma",
- "prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update",
- "build": "node node_modules/gulp-cli/bin/gulp.js"
-}
-```
## Running tests
You can use the provided Makefile to run all tests by using: