diff --git a/README.md b/README.md index 69cbced..6cedefe 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,7 @@ * **PAYLOAD**: le contenu. > **NOTE**: +* Si `TYPE` égale `1d` (`0001h`), alors il n'y à pas de contenu. * Si `HL` égale `10d` (`000ah`), alors il n'y à pas d'options. * Si `MDL` égale `0d` (`0000h`), alors il n'y à pas de méta-données. @@ -87,14 +88,15 @@ Le Cupfile doit se situer à la raçine de votre projet, exemple: reader: |-- .git/ |-- test/ - |-- python-windows-x86-64/ + `-- text.txt + |-- python-windows-x86_64/ |-- libraries.dll `-- python.exe - |-- python-linux-x86-64/ + |-- python-linux-x86_64/ |-- libraries.so `-- python |-- Cupfile - |-- main.py + `-- main.py ``` Voici un exemple de Cupfile, ce conteneur permet l'execution d'un script Python, en incluant toutes les dépendances: @@ -102,13 +104,33 @@ Voici un exemple de Cupfile, ce conteneur permet l'execution d'un script Python, AUTOR = Maiuri Gaëtan DATE = 2017-09-22 DESCRIPTION = A simple Cuper container with a text reader. -X-ENV = ["set:VERBOSE=1", "LD_LIBRARY_PATH=$_CWD/python-linux-x86-64/"] # LD_LIBRARY_PATH=... => is equivalent of add:LD_LIBRARY_PATH=... -X-INCLUDES = ["python-linux-x86-64/", "main.py"] +X-ENV = ["set:VERBOSE=1", "LD_LIBRARY_PATH=$_CWD/python-linux-x86_64/"] # LD_LIBRARY_PATH=... => is equivalent of add:LD_LIBRARY_PATH=... +X-INCLUDES = ["python-linux-x86_64/", "main.py"] -# POSIX -exec ./python-linux-x86-64/python main.py -v -i myfile.txt -# Windows -#exec python-windows-x86-64\python.exe main.py -v -i myfile.txt +exec ./python-linux-x86_64/python main.py -v -i myfile.txt +``` + +### Exemple avec des dépendances +Vous pouvez gérer **une liste de dépendances** avec l'attribut `X-DEPLIST`, exemple: + +```plain +reader: + |-- .git/ + |-- test/ + `-- text.txt + |-- Cupfile + `-- main.py +``` + +```bash +AUTOR = Maiuri Gaëtan +DATE = 2017-09-22 +DESCRIPTION = A simple Cuper container with a text reader. +X-DEPLIST = ["https://riz.example.com/download/python-linux-x86_64.riz"] +X-ENV = ["set:VERBOSE=1", "LD_LIBRARY_PATH=$_CWD/python-linux-x86_64/"] # LD_LIBRARY_PATH=... => is equivalent of add:LD_LIBRARY_PATH=... +X-INCLUDES = ["main.py"] + +exec ./python-linux-x86_64/python main.py -v -i myfile.txt ``` ## Constantes internes @@ -118,13 +140,16 @@ Des constantes internes sont utilisable dans le Cupfile, afin de formater dynami | Non | Type | Description | Exemple | |-----|:----:|-------------|---------| -| `$_CWD` | string | Le path du dossier courant post-extraction | `/path/to/riz/contents` | -| `$_HOME` | string | Le path du dossier utilisateur (de la machine cible) | `/home/batman` or `C:\Users\batman` | +| `$_CWD` | string | Le chemin du dossier courant post-extraction | `/path/to/riz/contents` | +| `$_HOME` | string | Le chemin du dossier utilisateur (de la machine cible) | `/home/batman` or `C:\Users\batman` | ## Attributs d'extension Les attributs d'extension permettent d'injecter des intructions à la compilation. | Non | Type | Description | Exemple | |-----|:----:|-------------|---------| +| `X-DEPLIST` | array | Inject des dépendances a télécharger avant extraction (sur la machine cible) | `["http://example.com/riz/my-scripts.riz", "http://example.com/riz/my-libs.riz"]` | | `X-ENV` | array | Inject des variables d'environnement dans le contexte d'execution (sur la machine cible) | `["VERBOSE=1", "LD_LIBRARY_PATH=libs/"]` | | `X-INCLUDES` | array | Inclure seulement ces fichiers/dossiers dans le conteneur | `["myfile", "mydir/"]` | + +L'attribut `X-DEPLIST` peut être grandement utile lors de la création d'un méta-conteneur.