Commit 46388a63 authored by James Laver's avatar James Laver Committed by Alexandre Delanoë

Update build instructions in README.md

parent bb8c31c7
...@@ -8,23 +8,31 @@ processing, text-mining, complex networks analysis and interactive data ...@@ -8,23 +8,31 @@ processing, text-mining, complex networks analysis and interactive data
visualization to pave the way toward new kinds of interactions with your visualization to pave the way toward new kinds of interactions with your
digital corpora. digital corpora.
This software is a free software, developed by the CNRS Complex Systems You will not find this software very useful without also running or being
granted access to a [backend](https://gitlab.iscpif.fr/gargantext/haskell-gargantext).
This software is free software, developed by the CNRS Complex Systems
Institute of Paris Île-de-France (ISC-PIF) and its partners. Institute of Paris Île-de-France (ISC-PIF) and its partners.
## Installation of this library ## Development
### Installing dependencies
### Dependencies warning Before building gargantext, you must install the dependencies. We use
This library purescript-gargantext is the Front End part of Gargantext. [yarn](https://yarnpkg.com/en/) for this. They have excellent[install
you need the backend (haskell-gargantext) installation too. instructions](https://yarnpkg.com/en/docs/install).
### Installation steps Then you must install the javascript and purescript dependencies:
1. Add `node_modules/.bin` to your path ```shell
2. Execute `./build` yarn install && yarn install-ps
```
In one command: ### Building
```PATH="$PWD/node_modules/.bin:$PATH" ./build``` ```shell
yarn build
```
## Note to the contributors ## Note to the contributors
...@@ -33,7 +41,7 @@ Please follow CONTRIBUTING.md ...@@ -33,7 +41,7 @@ Please follow CONTRIBUTING.md
## Introduction ## Introduction
Making sense of out text isn't actually that hard, but it does require Making sense of out text isn't actually that hard, but it does require
a little background knowledge to understand.x a little background knowledge to understand.
### N-grams ### N-grams
...@@ -61,6 +69,8 @@ N-grams are matched case insensitively and across whole words. Examples: ...@@ -61,6 +69,8 @@ N-grams are matched case insensitively and across whole words. Examples:
You may read more about n-grams [on wikipedia](https://en.wikipedia.org/wiki/N-gram). You may read more about n-grams [on wikipedia](https://en.wikipedia.org/wiki/N-gram).
<!-- TODO: Discuss punctuation -->
Gargantext allows you to define n-grams interactively in your browser Gargantext allows you to define n-grams interactively in your browser
and explore the relationships they uncover across a corpus of text. and explore the relationships they uncover across a corpus of text.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment