diff options
| author | John Molakvoæ <skjnldsv@users.noreply.github.com> | 2020-08-17 18:19:36 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-17 18:19:36 +0300 |
| commit | 9944290cea48ef59eac8d60b19caefa47a049cce (patch) | |
| tree | e115b058309d0f91ab1c78d4859183f8f61b08b2 /README.md | |
| parent | 2c03fa8231fc6c5724c77eb451d7cd019f1bfb75 (diff) | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 26 insertions, 4 deletions
@@ -1,12 +1,34 @@ files_pdfviewer ====== -This application integrates the [PDF.js](https://mozilla.github.io/pdf.js/) library into Nextcloud. Using this application users can view their PDF files online without downloading the file. +This application integrates the [PDF.js](https://mozilla.github.io/pdf.js/) library into Nextcloud. [](https://scrutinizer-ci.com/g/nextcloud/files_pdfviewer/?branch=master) [](https://scrutinizer-ci.com/g/nextcloud/files_pdfviewer/?branch=master) [](https://travis-ci.org/nextcloud/files_pdfviewer) -Maintainers -=========== -- [Lukas Reschke](https://github.com/LukasReschke) + +## 🏗 Development setup + +1. ☁ Clone this app into the `apps` folder of your Nextcloud: `git clone https://github.com/nextcloud/files_pdfviewer.git` +2. 👩💻 In the folder of the app, run the command `npm ci && npm run dev` to install dependencies and build the Javascript. +3. ✅ Enable the app through the app management of your Nextcloud +4. 🎉 Partytime! Help fix [some issues](https://github.com/nextcloud/files_pdfviewer/issues) and [review pull requests](https://github.com/nextcloud/files_pdfviewer/pulls) 👍 + + +### 🧙 Advanced development stuff + +To build the Javascript whenever you make changes, you can also use `npm run build`. Or `npm run watch` to automatically rebuild on every file save. + +You run all tests by using `make test`. + + +## ♥ How to create a pull request + +This guide will help you get started: +- 💃 [Opening a pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) + + +## ✌ Code of conduct + +The Nextcloud community has core values that are shared between all members during conferences, hackweeks and on all interactions in online platforms including [Github](https://github.com/nextcloud) and [forums](https://help.nextcloud.com). If you contribute, participate or interact with this community, please respect [our shared values](https://nextcloud.com/code-of-conduct/). 😌 |