A makefile, which manages blueprint compilation (runs Hercule when needed)
A Hercule, which actually couples blueprint sections together, and is an NPM tool
A validator implemented in JavaScript, and run in Node.js environment
A Bash script, which ensures that apiary.apib is up-to-date
Some not-yet-known tool which removes comments from compiled blueprints.
That's pretty complicated., and bound to *nix platform. Furthermore, In my attempt to rewrite a README (#27) I've realized that prerequisite steps recently became pretty difficult to describe, and probably discouraging to contributors.
My suggestion is to:
Introduce a package.json which would maintain dependencies. Currently all the dependencies, apart from Git, are actually NPM packages.
NPM is also a build tool, we can create custom scripts which run Hercule or perform validations. In the result, we can remove a makefile.
A Bash script is only needed in CI, so it doesn't need to be cross-platform.
Right now we rely on:
apiary.apib
is up-to-dateThat's pretty complicated., and bound to *nix platform. Furthermore, In my attempt to rewrite a README (#27) I've realized that prerequisite steps recently became pretty difficult to describe, and probably discouraging to contributors.
My suggestion is to: