diff --git a/_layouts/default.html b/_layouts/default.html index d530a10..a466803 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -32,7 +32,7 @@
This project is an attempt to raise the visiblity of code documentation in Ruby. It provides badges to include in your project's README, to show people that documenting code is a cool thing. @@ -19,25 +39,27 @@
Inch is a documentation measurement tool for Ruby that was created to help people document their code. It is a command-line utility that gives grades based on how complete the docs are (screenshots).
-I really think that posting these badges in a project's README will benefit the project (because people can see that it's well documented) and the community by improving the visibility of documentation.
Let's start a discussion, let's raise the visibility of documentation, let's talk. - Hit me up on Twitter or via issue.
-I'm @rrrene, creator of sparkr and Inch.
++ Hit me up on Twitter or create an issue in the Inch Pages project. +
To get a badge for your own projects, edit this file on GitHub and add your project in the form username/repo
:
I will in turn send you a pull request with your updated README (and a link to your "Inch Page", so you can check it first).
-- I would really like this to be one, but unfortunately I'm currently pretty busy (preparing my first teaching assignment). If this project gains traction, I will work on a web-service with hooks, oauth et al. - But until then, this solution can help us to raise awareness for good documentation in our projects. -
+ +{% markdown %} +### So is this a fully featured CI service? + +No, not yet at least. This is a ***community driven project*** based on GitHub Pages, passion, pull requests and a bit of manual labor on my part. + +Inch Pages is a social project at heart. +We can always implement a full-blown web-service after we have convinced a broader audience of the importance of inline documentation. + +But for now, the important bits for raising the visibility of code documentation are there: ***badges and status pages***. +{% endmarkdown %} +So: add your project! Pull requests are fun!
-I'm @rrrene, creator of sparkr and Inch.
++ Hit me up on Twitter or create an issue in the Inch Pages project. +