aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorVincent Peugnet <33429034+vincent-peugnet@users.noreply.github.com>2019-10-21 23:52:50 +0200
committerGitHub <noreply@github.com>2019-10-21 23:52:50 +0200
commit26c93a796eceb3de136695548ab80e5455bd932a (patch)
treefa1f36802cdae44625a7a87960c5347e127f326d /README.md
parentba671a7c0880f8154a7b86d4cb172b0171e84021 (diff)
parent016dc180d41c28c8fb0883b09a55b69cb060a0c1 (diff)
downloadwcms-26c93a796eceb3de136695548ab80e5455bd932a.tar.gz
wcms-26c93a796eceb3de136695548ab80e5455bd932a.zip
Merge pull request #13 from n-peugnet/add-code-mirror
Include CodeMirror in edit page
Diffstat (limited to 'README.md')
-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