summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGreg Roach <fisharebest@gmail.com>2017-12-30 14:22:13 +0000
committerGreg Roach <fisharebest@gmail.com>2018-01-02 20:18:10 +0000
commit27c4cda0cb98970e86f55c22a8248833b6cf40d9 (patch)
tree7f7f01577ead547aaefa1db79c77830836f6b5f6 /README.md
parent87f36d93a85c7feb25fe17c05ec58b902d02c08f (diff)
downloadwebtrees-27c4cda0cb98970e86f55c22a8248833b6cf40d9.tar.gz
webtrees-27c4cda0cb98970e86f55c22a8248833b6cf40d9.tar.bz2
webtrees-27c4cda0cb98970e86f55c22a8248833b6cf40d9.zip
Use npm/webpack/babel/laravel-mix to manage and bundle assets
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5018808093..790bc89a65 100644
--- a/README.md
+++ b/README.md
@@ -174,6 +174,24 @@ new version is available.
4. Unzip the .ZIP file, and upload the files to your web server, overwriting the existing files.
5. Delete the file **data/offline.txt**
+### Building and developing
+
+If you want to build webtrees from source, or modify the code, you'll need to install
+a couple of tools first.
+
+You will need [composer](https://getcomposer.org/) to install the PHP dependencies.
+Then run this command::
+
+* php composer.phar install
+
+You will need [npm](https://www.npmjs.com/get-npm) to install the Javascript dependencies.
+Then run the commands:
+
+* npm install
+* npm run prod
+
+You will need to re-run the second of these any time you modify the file `webtrees.js`.
+
#### Note for Macintosh users