Documentation for the CarbonCalculated framework. For more information on CarbonCalculated, These guides are based on the Rails Guides.
In order to start generating documentation, complete the following steps:
- clone CarbonCalculatedGuides from git://github.com/carboncalculated/carboncalculated_guides.git
- cd into carboncalculated_guides and run
guides generate
to generate the output directory
Once you've completed these steps, you're ready to start working with
CarbonCalculatedGuides. You'll do your work inside the source/ directory. As you make
changes, run guides generate
to see them reflected in the output.
If you have any questions, the team can be reached at @carbonhq