Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/text.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8b1378917..3b4d9564b 100644
--- a/README.md
+++ b/README.md
@@ -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) 👍