pitaya-launcher/README.md

48 lines
1.4 KiB
Markdown
Raw Normal View History

2015-08-26 14:08:12 +02:00
# Pitaya
2015-08-20 18:41:51 +02:00
2015-08-28 10:06:25 +02:00
Lanceur d'application pour GNU/Linux
2015-08-20 18:41:51 +02:00
## Démarrer avec les sources
### Dépendences de développement
- [NodeJS](https://nodejs.org/) - Dernière version stable, testé sur la 0.12.*
- [NPM](https://www.npmjs.com/) - Normalement automatiquement installé avec NodeJS.
### Initialisation du projet
2015-08-20 18:41:51 +02:00
```
2015-08-28 10:06:25 +02:00
git clone https://forge.cadoles.com/wpetit/pitaya.git
2015-08-26 14:08:12 +02:00
cd pitaya
2015-08-20 18:41:51 +02:00
git checkout develop
npm install
2015-09-11 16:25:45 +02:00
DEBUG=pitaya* npm start
2015-08-20 18:41:51 +02:00
```
## Variables d'environnement
Vous pouvez configurer le comportement de Pitaya en passant des variables d'environnement:
2015-08-20 18:41:51 +02:00
| Variable | Description | Valeurs possibles | Valeur par défaut |
|-------------------|------------------------------------|-------------------|------------------------|
| PITAYA_MODE | Mode d'exécution de Pitaya | launcher, edit | launcher |
| PITAYA_PROFILE | Chemin du fichier profil à charger | -- | ./default-profile.json |
| PITAYA_AS_DESKTOP | Afficher Pitaya en mode "Bureau" | 1, 0 | 0 |
2015-08-20 18:41:51 +02:00
## Comment construire l'application depuis les sources
```
npm run build
```
2015-08-26 14:08:12 +02:00
Un dossier `pitaya-<version>-<target>-<arch>` sera créé dans le répertoire `./build`. Celui ci contient tous les fichiers nécessaires à l'application.
## Comment contribuer
2015-08-20 18:41:51 +02:00
Ce projet utilise la méthodologie [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/).
2015-08-28 10:06:25 +02:00
## Licence
GPLv3