aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorn-peugnet <n.peugnet@free.fr>2019-10-21 19:27:22 +0200
committern-peugnet <n.peugnet@free.fr>2019-10-21 21:49:12 +0200
commit01355d4e0173036fefe513ddf51f4d81ec66d90a (patch)
tree482dd2f2fadc81a3f0d01ebfca8273d8c7a578f5
parent137f4369c2e1194da3bb733193b8636f7ae4c028 (diff)
downloadwcms-01355d4e0173036fefe513ddf51f4d81ec66d90a.tar.gz
wcms-01355d4e0173036fefe513ddf51f4d81ec66d90a.zip
add build instructions in README
-rw-r--r--README.md31
1 files changed, 30 insertions, 1 deletions
diff --git a/README.md b/README.md
index ee3dadd..ff1315f 100644
--- a/README.md
+++ b/README.md
@@ -46,11 +46,40 @@ There is lot more you can by altering the `BODY`.
using [James Moss's Flywheel Database](https://github.com/jamesmoss/flywheel), [Michel Fortin's Markdown Extra](https://github.com/michelf/php-markdown) and [Plates](https://github.com/thephpleague/plates) as lightweight template engine.
+# Install from sources
+
+If you want to contribute to the project.
+
+## Prerequisites
+
+- PHP ^5.6
+- [Composer](https://getcomposer.org/)
+- _Optionally_ [NPM](https://www.npmjs.com/get-npm)
+
+### Debian and derivatives
+
+ sudo apt install php composer nodejs
+
+## Installation
+
+1. Clone the git repository.
+2. Install PHP dependencies.
+
+ composer install
+
+3. _Optionnally_ install and build JS dependencies to get UI enhancements.
+
+ npm install && npm run build
+
+## Development
+
+While developing the JS sources it is useful to run webpack in watch mode so that the bundles get built at each file change. To do so, use the following command:
+
+ npm run watch
To Do
=====
-- Implement Code Mirror as editing interface instead of basic text area
- Locking page system by super editor to prevent editing by the wrong person