diff options
author | splitt3r <splitt3r@users.noreply.github.com> | 2017-10-07 21:51:45 +0300 |
---|---|---|
committer | splitt3r <splitt3r@users.noreply.github.com> | 2017-10-07 21:51:45 +0300 |
commit | 8b36e942147453003f58f442bc54d1429b297f4d (patch) | |
tree | 034c53201d77da015771a502b2c89e391ffc5984 /README.md | |
parent | 320781094096037eab7d0014dad2d13fe1f2ad40 (diff) |
Tabs => spaces, README, some misc changes
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 96 |
1 files changed, 71 insertions, 25 deletions
@@ -1,33 +1,79 @@ -polls -===== -This is a poll app, similar to doodle or dudle, for Nextcloud/ownCloud written in PHP and JS/jQuery. +# Polls + +This is a poll app, similar to doodle or dudle, for Nextcloud / ownCloud written in PHP and JS / jQuery. It is a rework of the already existing [polls app](https://github.com/raduvatav/polls) written by @raduvatav. -Features -======== -- Create/Edit polls (datetimes _and_ texts) -- Set expiration date -- Restrict access (only logged in users, certain groups/users, hidden and public) -- Comments +### Features + +- :bar_chart: Create / edit polls (datetimes _and_ texts) +- :date: Set expiration date +- :lock: Restrict access (only logged in users, certain groups / users, hidden and public) +- :speech_balloon: Comments -Requirements -============ -- Just a currently maintained Nexcloud/ownCloud +### Bugs -Bugs -==== - https://github.com/nextcloud/polls/issues -Installation -============ -Put the files under `<clouds_main_directory>/apps/polls` and enable it in the apps menu. +### Screenshots + +![New poll](https://github.com/nextcloud/polls/blob/master/screenshots/new-poll.png) +![Overview](https://github.com/nextcloud/polls/blob/master/screenshots/overview.png) +![Vote](https://github.com/nextcloud/polls/blob/master/screenshots/vote.png) + +## Installation / Update + +This app is supposed to work on Nextcloud version 11+ or ownCloud version 8+. + +### Install latest release + +You can download and install the latest release from the [Nextcloud app store](https://apps.nextcloud.com/apps/polls). + +### 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: + +``` +git clone https://github.com/nextcloud/polls.git +``` + +## Contribution Guidelines + +Please read the [Code of Conduct](https://nextcloud.com/community/code-of-conduct/). This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other. + +For more information please review the [guidelines for contributing](https://github.com/nextcloud/server/blob/master/CONTRIBUTING.md) to this repository. + +### Apply a license + +All contributions to this repository are considered to be licensed under +the GNU AGPLv3 or any later version. + +Contributors to the Deck app retain their copyright. Therefore we recommend +to add following line to the header of a file, if you changed it substantially: + +``` +@copyright Copyright (c) <year>, <your name> (<your email address>) +``` + +For further information on how to add or update the license header correctly please have a look at [our licensing HowTo][applyalicense]. + +### Sign your work + +We use the Developer Certificate of Origin (DCO) as a additional safeguard +for the Nextcloud project. This is a well established and widely used +mechanism to assure contributors have confirmed their right to license +their contribution under the project's license. +Please read [developer-certificate-of-origin][dcofile]. +If you can certify it, then just add a line to every git commit message: + +```` + Signed-off-by: Random J Developer <random@developer.example.org> +```` -Misc -==== -The app is also available at the [App Store](https://apps.nextcloud.com/apps/polls). +Use your real name (sorry, no pseudonyms or anonymous contributions). +If you set your `user.name` and `user.email` git configs, you can sign your +commit automatically with `git commit -s`. You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases) +like `git config --global alias.ci 'commit -s'`. Now you can commit with +`git ci` and the commit will be signed. -Screenshots -=========== -![](https://github.com/nextcloud/polls/blob/master/screenshots/new-poll.png) -![](https://github.com/nextcloud/polls/blob/master/screenshots/overview.png) -![](https://github.com/nextcloud/polls/blob/master/screenshots/vote.png) +[dcofile]: https://github.com/nextcloud/server/blob/master/contribute/developer-certificate-of-origin +[applyalicense]: https://github.com/nextcloud/server/blob/master/contribute/HowToApplyALicense.md |