protagonist
Advanced tools
Comparing version 0.0.8 to 0.0.9
{ | ||
"name": "protagonist", | ||
"version": "0.0.8", | ||
"version": "0.0.9", | ||
"description": "API Blueprint Parser", | ||
@@ -5,0 +5,0 @@ "author": "Apiary.io <support@apiary.io>", |
@@ -6,3 +6,3 @@ # Protagonist [![Build Status](https://travis-ci.org/apiaryio/protagonist.png?branch=master)](https://travis-ci.org/apiaryio/protagonist) | ||
API Blueprint is REST API documentation language. Full API Blueprint documentation can be found on the [API Blueprint site](http://apiblueprint.org). | ||
API Blueprint is Web API documentation language. You can find API Blueprint documentation on the [API Blueprint site](http://apiblueprint.org). | ||
@@ -28,2 +28,3 @@ ## Install | ||
## Hacking | ||
@@ -35,12 +36,12 @@ You are welcome to contribute. Use following steps to build & test Protagonist. | ||
1. Clone the repo + fetch the submodules: | ||
1. If needed, install node-gyp: | ||
$ npm install -g node-gyp | ||
2. Clone the repo + fetch the submodules: | ||
$ git clone git://github.com/apiaryio/protagonist.git | ||
$ cd protagonist | ||
$ git submodule update --init --recursive | ||
2. If needed, install node-gyp: | ||
$ cd .. | ||
$ npm install -g node-gyp | ||
@@ -47,0 +48,0 @@ 3. Build: |
# Snow Crash [![Build Status](https://travis-ci.org/apiaryio/snowcrash.png?branch=master)](https://travis-ci.org/apiaryio/snowcrash) | ||
### API Blueprint Parser | ||
@@ -6,6 +7,6 @@ | ||
API Blueprint is REST API documentation language. Full API Blueprint documentation can be found on the [API Blueprint site](http://apiblueprint.org). | ||
API Blueprint is Web API documentation language. You can find API Blueprint documentation on the [API Blueprint site](http://apiblueprint.org). | ||
## Status | ||
At this moment Snow Crash is Work in Progress. See its [Wiki status page](https://github.com/apiaryio/snowcrash/wiki/API-Blueprint-Implementation-Status) for details on progress of implementing API Blueprint Format 1A. | ||
Snow Crash is Work in Progress. See its [Wiki status page](https://github.com/apiaryio/snowcrash/wiki/API-Blueprint-Implementation-Status) for details. | ||
@@ -18,11 +19,5 @@ ## Bindings | ||
## Build | ||
Snow Crash uses [Gyp](http://code.google.com/p/gyp/) build automation tool to generates its Makefile. | ||
1. Clone the repo + fetch the submodules: | ||
Snow Crash uses [Gyp](http://code.google.com/p/gyp/) build automation tool to generates its Makefiles. | ||
$ git clone git://github.com/apiaryio/snowcrash.git | ||
$ cd snowcrash | ||
$ git submodule update --init --recursive | ||
2. If needed, install Gyp. Either from its package: | ||
1. If needed, install Gyp. Either from its package: | ||
@@ -38,5 +33,11 @@ $ sudo apt-get install gyp | ||
See [Gyp Hello World](https://github.com/springmeyer/hello-gyp) for a primer on installing and using Gyp. | ||
2. Clone the repo + fetch the submodules: | ||
3. Build Snow Crash: | ||
$ git clone git://github.com/apiaryio/snowcrash.git | ||
$ cd snowcrash | ||
$ git submodule update --init --recursive | ||
3. Build & test Snow Crash: | ||
$ ./configure | ||
@@ -46,6 +47,3 @@ $ make test | ||
## Test | ||
To run bundled test simply run: | ||
$ make test | ||
### Build `snowcrash` command line tool | ||
@@ -52,0 +50,0 @@ To build & run Snow Crash command line tool use: |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
1473036
58