diff options
| author | John Molakvoæ <skjnldsv@users.noreply.github.com> | 2020-08-17 23:25:16 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-17 23:25:16 +0300 |
| commit | 9f22adf9c9b28a87a15ef3f441991cc7e7fd612f (patch) | |
| tree | 8d1aaa1e062bad75aac120e5b88f71dfaf4de660 /README.md | |
| parent | 9df0d0eb46e9704d9a22a921409298f55858772f (diff) | |
| parent | 2ddd8ebab2e97500dc0419c2e89de97f9ae431b3 (diff) | |
Merge branch 'master' into update-readme-appinfo
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 28 insertions, 4 deletions
@@ -1,12 +1,36 @@ 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 documents and Illustrator® (.ai) files online without downloading the file. +This application integrates the [PDF.js](https://mozilla.github.io/pdf.js/) library into Nextcloud's Viewer. +You can view PDF files as well as Adobe Illustrator files (.ai) [](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` +1. ☁ Clone the viewer app into the `apps` folder of your Nextcloud: `git clone https://github.com/nextcloud/viewer.git` +2. 👩💻 In the folder of the files_pdfviewer 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 (viewer should be enabled by default) +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/). 😌 |