cms/corpus_module/README.md
author nowmad@23.1.168.192.in-addr.arpa
Fri, 13 Nov 2015 11:04:04 +0100
changeset 16 70e9a764d6d7
parent 14 10f67f0281e1
child 17 ac3dc090e987
permissions -rw-r--r--
add all tabs corresponding to each visualization, update name and structure and create a simple squeleton
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
14
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     1
# Corpus module
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     2
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     3
This README describes how to configure this Drupal module in order to add it to your Drupal project.
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     4
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     5
## Prerequisites
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     6
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     7
You will need the following things properly installed on your computer.
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     8
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     9
* A Drupal project
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    10
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    11
## Installation
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    12
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    13
* Place this module into the modules/ folder of your Drupal project.
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    14
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    15
### Configuration
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    16
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    17
You can setting up the module by changing the following variable in the corpus.module file:
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    18
* define('CORPUS_URL', 'corpus'); - The url to access to your module
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    19
* define('CORPUS_APP', 'app-client'); - The name of the folder the module look into to find the ember app to embed
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    20
* define('MODULE_NAME', 'corpus'); - The name of the module. It must match the name of the module folder.