Skip to content

Commit

Permalink
Updated index, added licence, and added rake task to publish docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tomafro committed Aug 25, 2011
1 parent 756c9d9 commit ca99bbf
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 0 deletions.
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Original file line Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (C) 2011 by Tom Ward

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
7 changes: 7 additions & 0 deletions Rakefile
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -3,3 +3,10 @@ require 'rocco/tasks'


desc 'build docs' desc 'build docs'
Rocco::Task.new :rocco, 'doc/', ['index.rb', 'lib/tomafro/**/*.rb'] Rocco::Task.new :rocco, 'doc/', ['index.rb', 'lib/tomafro/**/*.rb']

desc 'publish docs'
task :publish do
sha = `git ls-tree -d HEAD doc | awk '{print $3}'`.strip
commit = `echo "Publishing docs from master branch" | git commit-tree #{sha} -p refs/heads/gh-pages`.strip
`git update-ref refs/heads/gh-pages #{commit}`
end
12 changes: 12 additions & 0 deletions doc/index.html
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -49,6 +49,18 @@
<p>Most of the documentation can be found with the <a href="lib/tomafro/deploy.html">main recipe</a>, while the <p>Most of the documentation can be found with the <a href="lib/tomafro/deploy.html">main recipe</a>, while the
<a href="lib/tomafro/deploy/bundler.html">bundler</a> and <a href="lib/tomafro/deploy/foreman.html">foreman</a> recipes document <a href="lib/tomafro/deploy/bundler.html">bundler</a> and <a href="lib/tomafro/deploy/foreman.html">foreman</a> recipes document
their extensions.</p> their extensions.</p>
</td>
<td class=code>
<div class='highlight'><pre></pre></div>
</td>
</tr>
<tr id='section-3'>
<td class=docs>
<div class="pilwrap">
<a class="pilcrow" href="#section-3">&#182;</a>
</div>
<p>The code is available <a href="http://github.com/tomafro/tomafro-deploy">on github</a> and released under the
<a href="http://github.com/tomafro/tomafro-deploy/LICENSE">MIT License</a></p>


</td> </td>
<td class=code> <td class=code>
Expand Down
3 changes: 3 additions & 0 deletions index.rb
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
# Most of the documentation can be found with the [main recipe](lib/tomafro/deploy.html), while the # Most of the documentation can be found with the [main recipe](lib/tomafro/deploy.html), while the
# [bundler](lib/tomafro/deploy/bundler.html) and [foreman](lib/tomafro/deploy/foreman.html) recipes document # [bundler](lib/tomafro/deploy/bundler.html) and [foreman](lib/tomafro/deploy/foreman.html) recipes document
# their extensions. # their extensions.

# The code is available [on github](http://github.com/tomafro/tomafro-deploy) and released under the
# [MIT License](http://github.com/tomafro/tomafro-deploy/LICENSE)

0 comments on commit ca99bbf

Please sign in to comment.