Skip to content

Add working instructions to use this tutorial directly. #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 24, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
[submodule "overdrive/etc/shellfire/paths.d"]
path = overdrive/etc/shellfire/paths.d
url = https://github.com/shellfire-dev/paths.d.git
[submodule "overdrive/lib/shellfire/core"]
path = overdrive/lib/shellfire/core
url = https://github.com/shellfire-dev/core.git
[submodule "overdrive/lib/shellfire/jsonreader"]
path = overdrive/lib/shellfire/jsonreader
url = https://github.com/shellfire-dev/jsonreader.git
Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# A 10 min tutorial to create the [shellfire] application 'overdrive'
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`).
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:

```bash
git submodule update --init
cd overdrive
./overdrive gearbox.json
cat gearbox.xml
```

'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.

Expand Down
1 change: 1 addition & 0 deletions overdrive/lib/shellfire/core
Submodule core added at a46de3