diff options
author | Jan-Christoph Borchardt <hey@jancborchardt.net> | 2019-05-14 18:13:23 +0300 |
---|---|---|
committer | Jan-Christoph Borchardt <hey@jancborchardt.net> | 2019-05-14 18:13:23 +0300 |
commit | 21a3d5ca3851158fde48dfda9ff4ae0159c29e27 (patch) | |
tree | 3c8396e45590c51f4e80dd958b247c0060bfe9c8 | |
parent | e5711781cfe5aeb7e79ff50482394abecb74af7f (diff) |
Simplify dev setup instructions
Signed-off-by: Jan-Christoph Borchardt <hey@jancborchardt.net>
-rw-r--r-- | README.md | 17 |
1 files changed, 9 insertions, 8 deletions
@@ -2,13 +2,14 @@ **Collaborative markdown editing** -## Development setup +## 🏗 Development setup -Current requirements: -- master branch of the viewer app https://github.com/nextcloud/viewer +Currently this app requires the 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/text/issues) and [review pull requests](https://github.com/nextcloud/text/pulls) 👍 +1. ☁ Clone this app into the `apps` folder of your Nextcloud: `git clone https://github.com/nextcloud/text.git` +2. 👩💻 In the folder of the app, run the command `make` 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/text/issues) and [review pull requests](https://github.com/nextcloud/text/pulls) 👍 + +### 🧙 Advanced development stuff +To build the Javascript whenever you make changes, instead of the full `make` you can also run `npm run build`. Or run `npm run watch` to rebuild on every file save. |