Commit d38006e1 authored by Jerome Chauveau's avatar Jerome Chauveau
Browse files

readme update

parent 3952576b
Loading
Loading
Loading
Loading
+11 −2
Original line number Diff line number Diff line
@@ -18,9 +18,10 @@ make help
## Démarrage rapide

Installation de MaX, du corpus de démonstration et lancement du service :

```
make install && make demo && make run
````
```

Pour ajouter des sources xml :

@@ -93,7 +94,7 @@ Il contient le serveur BaseX. C'est un dossier (caché) purement technique dans

- `.max/basex/webapp/max/` pointe vers  `src/main`

Lien automatiquement créé par la commande `make install`
Lien automatiquement créé par la commande `make install`.

## Les routes principales

@@ -112,6 +113,14 @@ Elles sont déclarées dans le fichier `src/main/core/routes.xqm` :
- `/about.html` : affiche les informations de configuration et d'environnement (disponible uniquement en mode `dev`)
- `/doc/functions.html` : documentation API XQuery de MaX (disponible uniquement en mode `dev`)

## Organisation d'un corpus numérique

 - un fichier config.xml
 - un dossier `templates` (optionnel) : contient les templates HTML (en surcharge/complément de ceux du bundle de vocabulaire)
 - un dossier `autoroute` (optionnel)
 - un dossier `content_html` (optionnel) : contient les contenus HTML (ou markdown)
 - un dossier `locales` (optionnel) : les fichiers d'internationalisation (en surcharge/complément de ceux du bundle de vocabulaire)


## Développement d'un bundle de vocabulaire