Skip to content

Commit

Permalink
Add intro documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
j3k0 committed Oct 24, 2014
1 parent 1038bc2 commit bb48a90
Show file tree
Hide file tree
Showing 6 changed files with 559 additions and 9 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,14 @@ check-jshint:
doc-api: test-js
@echo "# API Documentation" > doc/api.md
@echo >> doc/api.md
@echo "(generated from source files using \`make doc-api)\`" >> doc/api.md
@echo "*(generated from source files using \`make doc-api)\`*" >> doc/api.md
@echo >> doc/api.md
@cat test/store-test.js | grep "///" | cut -d/ -f4- | cut -d\ -f2- >> doc/api.md
@cat test/store-test-src.js | grep "///" | cut -d/ -f4- | cut -d\ -f2- >> doc/api.md

doc-contrib: test-js
@echo "# Contributor Guide" > doc/contributor-guide.md
@echo >> doc/contributor-guide.md
@echo "(generated from source files using \`make doc-api)\`" >> doc/contributor-guide.md
@echo "*(generated from source files using \`make doc-contrib)\`*" >> doc/contributor-guide.md
@echo >> doc/contributor-guide.md
@cat src/js/*.js | grep "//!" | cut -d! -f2- | cut -d\ -f2- >> doc/contributor-guide.md

Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you don't know much about In-App Purchases, you'll find a good introduction
on the subject on Fovea's blog *(coming soon)*.

You probably want to start by installing the plugin into your project.
This is documented in the [Setup Guide](doc/setup.md). *(coming soon)*
This is documented in the [Setup Guide](wiki/Setup)

Once your project is setup properly, add the minimal initialization code in
your project and check that it works. You'll find a [Minimal Example Here](doc/minimal-example.js).
Expand Down Expand Up @@ -49,6 +49,7 @@ If you can't get things to work, go through the [Troubleshooting Checklist](doc/

### Contributors:

* Jean-Christophe Hoelt
* Guillaume Charhon (initial Android code)
* Matt Kane (initial iOS code)
* Mohammad Naghavi (original unification attempt)
Expand Down
Loading

0 comments on commit bb48a90

Please sign in to comment.