Skip to content

Commit 5a496f0

Browse files
committed
Merge pull request #1 from rduplain/master
Add working instructions to use this tutorial directly.
2 parents a9c2dff + ce989cc commit 5a496f0

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[submodule "overdrive/etc/shellfire/paths.d"]
22
path = overdrive/etc/shellfire/paths.d
33
url = https://github.com/shellfire-dev/paths.d.git
4+
[submodule "overdrive/lib/shellfire/core"]
5+
path = overdrive/lib/shellfire/core
6+
url = https://github.com/shellfire-dev/core.git
47
[submodule "overdrive/lib/shellfire/jsonreader"]
58
path = overdrive/lib/shellfire/jsonreader
69
url = https://github.com/shellfire-dev/jsonreader.git

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# A 10 min tutorial to create the [shellfire] application 'overdrive'
2-
If you'd rather not follow along, or if you'd prefer to see a complete application, take a look at the files in `overdrive`. (On a Mac with TextMate, `mate tutorial/overdrive`).
2+
If you'd rather not follow along, or if you'd prefer to see a complete application, take a look at the files in `overdrive`. (On a Mac with TextMate, `mate tutorial/overdrive`). To run the completed tutorial, clone this repository, then run in the project root:
3+
4+
```bash
5+
git submodule update --init
6+
cd overdrive
7+
./overdrive gearbox.json
8+
cat gearbox.xml
9+
```
310

411
'overdrive' is intended to be a simple application that converts 'GearBox' JSON files to XML. It shows how to quickly parse command lines, validate arguments and use the JSON and XML libraries.
512

overdrive/lib/shellfire/core

Submodule core added at a46de32

0 commit comments

Comments
 (0)