... | ... | @@ -9,17 +9,32 @@ This short tutorial provides a brief overview of the Myriad internals. |
|
|
|
|
|
To bootstrap the development of a new *Myriad*-based data generator project, please follow these steps.
|
|
|
|
|
|
First, create the root folder for the new project (let's call it *my-datagen*) and setup the initial folder structure. Assuming you want to use git to version the source code of your generator, the recommended way to do this is to check out the [myriad-toolkit](https://github.com/TU-Berlin-DIMA/myriad-toolkit) project as a git submodule:
|
|
|
First, create the root folder for the new project (let's call it *my-datagen*) and setup the initial folder structure.
|
|
|
|
|
|
|
|
|
```bash
|
|
|
my_datagen=my-datagen #name your data generator
|
|
|
mkdir $my_datagen
|
|
|
cd $my_datagen
|
|
|
mkdir vendor
|
|
|
```
|
|
|
|
|
|
|
|
|
### a) Checkout Myriad's Git Repository
|
|
|
Assuming you want to use git to version the source code of your generator, the recommended way to do this is to check out the [myriad-toolkit](https://github.com/TU-Berlin-DIMA/myriad-toolkit) project as a git submodule:
|
|
|
|
|
|
```bash
|
|
|
git init
|
|
|
git submodule add git://github.com/TU-Berlin-DIMA/myriad-toolkit.git vendor/myriad-toolkit
|
|
|
```
|
|
|
|
|
|
### b) Download Myriad as Zip
|
|
|
Alternatively you can download the myriad-toolkit as an archive file. Place the unzipped toolkit into the *vendor* folder and remove the version suffix:
|
|
|
|
|
|
```bash
|
|
|
unzip -d ./vendor <path-to-myriad-toolkit.zip>
|
|
|
mv ./vendor/myriad-toolkit-<version> ./vendor/myriad-toolkit
|
|
|
```
|
|
|
|
|
|
The *Myriad Toolkit* comes with a standard command line assistant tool available under `vendor/myriad-toolkit/bin/assistant`. This tool greatly simplifies the implementation process by providing support for common development tasks. As you probably end up using the CLI tool a lot (especially if you intend to develop a new generator from scratch), we suggest creating a soft link to it under the project root:
|
|
|
|
|
|
```bash
|
... | ... | |