Commit 94085219 authored by Michele Memoli's avatar Michele Memoli

Added note about '|' character to readme

parent f7eedbe2
...@@ -17,19 +17,26 @@ This tool will list out all the possible scenarios for you based on the [cartesi ...@@ -17,19 +17,26 @@ This tool will list out all the possible scenarios for you based on the [cartesi
Imagine you're creating a recipe site. The site has: Imagine you're creating a recipe site. The site has:
- 3 different types of user accounts: _viewer_, _subscriber_, _contributer_ - 3 different types of user accounts: _viewer_, _subscriber_, _contributer_ (some are paid-for)
- A favouriting mechanism on each recipe - A favouriting mechanism on each recipe
- 3 layouts: _small_, _medium_ and _large_ - 3 layouts: _small_, _medium_ and _large_
- A privacy setting: _public_, _private_ - A privacy setting: _public_, _private_
Anyone building this UI on your behalf needs to understand how you want the UI to look for each of these scenarios. Rather than guess that list, use this Scenarios Scaffolding tool. Anyone building this UI on your behalf needs to understand how you want the UI to look for each of these scenarios. Rather than guess that list, use this Scenarios Scaffolding tool.
Set up your variables like this (see [config.yml](config.yml)). The order doesn't matter: Set up your variables like this (see [config.yml](config.yml)). The `headers` is important – it must come first – the rest don't matter:
headers:
- account_type
- revenue
- favourited
- layout
- privacy
account_type: account_type:
- viewer - viewer|0
- subscriber - subscriber|5
- contributer - contributer|20
favourited: favourited:
- favourite - favourite
...@@ -44,13 +51,16 @@ Set up your variables like this (see [config.yml](config.yml)). The order doesn' ...@@ -44,13 +51,16 @@ Set up your variables like this (see [config.yml](config.yml)). The order doesn'
- public - public
- private - private
## Notice the `|`?
That allows you to configure extra rows in your columns. For example, you might not want to multiply every scenario by the "revenue" column but having it separate means you'll be able to filter by it later on.
When you run the project you get a `.csv` file which you can import into excel or Google Sheets to process further. It looks like this: When you run the project you get a `.csv` file which you can import into excel or Google Sheets to process further. It looks like this:
account_type,favourited,layout,privacy account_type,revenue,favourited,layout,privacy
viewer,favourite,small,public viewer,0,favourite,small,public
subscriber,favourite,small,public subscriber,5,favourite,small,public
contributer,favourite,small,public contributer,20,favourite,small,public
viewer,not-favourited,small,public
... ...
......
headers: headers:
- device - account_type
- form - revenue
- platform - favourited
- orientation - layout
- screen - privacy
- size
devices: account_type:
- iPhone 6|mobile|iOS|portrait - viewer|0
- iPhone 5|mobile|iOS|portrait - subscriber|5
- Retina iPad|tablet|iOS|portrait - contributer|20
- Retina iPad|tablet|iOS|landscape
- Google Pixel|mobile|Android|portrait
- Nexus 10|tablet|Android|portrait
- Nexus 10|tablet|Android|landscape
screens: favourited:
- Home|L - favourite
- Search|S - not-favourited
- Add Project|M
- Dispute|L layout:
- favouriting|S - small
- medium
- large
privacy:
- public
- private
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