aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2021-10-06 09:48:57 +0200
committerJoas Schilling <coding@schilljs.com>2021-10-06 09:48:57 +0200
commit3869f07f4be062ce171e7d788f3e64dc8f7ea8d2 (patch)
treec7cc714d43c7eeb4fbf325489179b27a2d8137c3 /README.md
parent442eb6cc0e031bdbff910b0e15b84cb5dcf8fb73 (diff)
downloadnextcloud-server-3869f07f4be062ce171e7d788f3e64dc8f7ea8d2.tar.gz
nextcloud-server-3869f07f4be062ce171e7d788f3e64dc8f7ea8d2.zip
Fix some typos and code blocks in readme
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index ddfe70300d6..f955bdb10f3 100644
--- a/README.md
+++ b/README.md
@@ -62,7 +62,7 @@ Otherwise, git checkouts can be handled the same as release archives, by using t
We are moving more and more towards using Vue.js in the frontend, starting with Settings. For building the code on changes, use these terminal commands in the root folder:
-``` bash
+```bash
# install dependencies
make dev-setup
@@ -76,30 +76,30 @@ make watch-js
make build-js-production
```
-#### Commiting changes
+#### Committing changes
**When making changes, also commit the compiled files!**
We still use Handlebars templates some places in Files and Settings. We will replace these step-by-step with Vue.js, but in the meantime you need to compile them separately.
If you don’t have Handlebars installed yet, you can do it with this terminal command:
-```
+```bash
sudo npm install -g handlebars
```
Then inside the root folder of your local Nextcloud development installation, run this command in the terminal every time you changed a `.handlebars` file to compile it:
-```
+```bash
./build/compile-handlebars-templates.sh
```
Before checking in JS changes, make sure to also build for production:
-```
+```bash
make build-js-production
```
Then add the compiled files for committing.
To save some time, to only rebuild for a specific app, use the following and replace the module with the app name:
-```
+```bash
MODULE=user_status make build-js-production
```