This repo serves two purposes: (1) It defines the guidelines and best practices for Joyent engineering work (this is the primary goal), and (2) it also provides boilerplate for a SmartDataCenter (SDC) project repo, giving you a starting point for many of the suggestion practices defined in the guidelines. This is especially true for node.js-based REST API projects.
You probably want to be looking at the actual Joyent engineering guide at docs/index.md. This README.md is a template for repos to use.
Describe steps necessary for development here.
make all
Describe steps necessary for testing here.
make test
Joyent Engineering Guide is at docs/index.md.
To update the guidelines, edit "docs/index.md" and run make docs
to update "docs/index.html". Works on either SmartOS or Mac OS X.
Create a new repo called "some-cool-fish" in "~/work" based on "eng.git":
./tools/mkrepo $HOME/work/some-cool-fish
Add other sections to your README as necessary. E.g. Running a demo, adding development data.
"eng: Joyent Engineering Guide" is licensed under the Mozilla Public License version 2.0. See the file LICENSE.