diff options
| author | Julius Härtl <jus@bitgrid.net> | 2019-05-14 10:41:07 +0300 |
|---|---|---|
| committer | Julius Härtl <jus@bitgrid.net> | 2019-05-14 10:41:07 +0300 |
| commit | 7936d25ea6234eb5720fa60b7b5995ce7d8bc9ab (patch) | |
| tree | 1ab7af76869768ed596f4893c711cc1cfacce25a /README.md | |
| parent | fe6272f411f502b5734f74270f62fed17a0a8156 (diff) | |
Add readme with basic build instructions (fixes #9)
Signed-off-by: Julius Härtl <jus@bitgrid.net>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
@@ -1 +1,15 @@ +# Nextcloud Text +**Collaborative markdown editing** + + +## Development setup + +Current requirements: +- master branch of the viewer app https://github.com/nextcloud/viewer + +1. ☁ Clone the app into the `apps` folder of your Nextcloud: `git clone https://github.com/nextcloud/text.git` +2. 👩💻 Run `npm install` to install the dependencies +3. 🏗 To build the Javascript whenever you make changes, run `npm run build` or run `npm run watch` once to rebuild on every file save +4. ✅ Enable the app through the app management of your Nextcloud +5. 🎉 Partytime! Help fix [some issues](https://github.com/nextcloud/social/issues) and [review pull requests](https://github.com/nextcloud/social/pulls) 👍 |