website/index.html in newgem-0.29.0 vs website/index.html in newgem-1.0.0
- old
+ new
@@ -37,11 +37,11 @@
<h1>New Gem Generator</h1>
<div class="sidebar">
<div id="version"> <!-- class="clickable" onclick='document.location = "http://rubyforge.org/projects/newgem"; return true' -->
<p>Get Version</p>
- <a href="http://rubyforge.org/projects/newgem" class="numbers">0.29.0</a>
+ <a href="http://rubyforge.org/projects/newgem" class="numbers">1.0.0</a>
<p>Featured in</p>
<a href="http://www.amazon.com/gp/redirect.html?ie=UTF8&location=http%3A%2F%2Fwww.amazon.com%2FBeginning-Ruby-Novice-Professional-Experts%2Fdp%2F1590597664%2F&tag=drnic-20&linkCode=ur2&camp=1789&creative=9325" class="book"><img src="images/beginning-ruby.jpg" /></a>
</div>
<div id="twitter_search">
@@ -73,31 +73,28 @@
$ newgem wizzo
create
create config
create doc
create lib
- create log
create script
create tasks
- create test
- create tmp
create lib/wizzo
create History.txt
- create License.txt
create Rakefile
- create README.txt
- create setup.rb
+ create README.rdoc
+ create PostInstall.txt
create lib/wizzo.rb
create lib/wizzo/version.rb
create config/hoe.rb
create config/requirements.rb
- create log/debug.log
create tasks/deployment.rake
create tasks/environment.rake
create tasks/website.rake
- create test/test_helper.rb
- create test/test_wizzo.rb
+ dependency install_test_unit
+ create test
+ create test/test_helper.rb
+ create test/test_wizzo.rb
dependency install_website
create website/javascripts
create website/stylesheets
exists script
exists tasks
@@ -113,19 +110,19 @@
create website/javascripts/rounded_corners_lite.inc.js
dependency install_rubigen_scripts
exists script
create script/generate
create script/destroy
+ create script/console
create Manifest.txt
readme readme
Important
=========
* Open config/hoe.rb
-* Update missing details (gem description, dependent gems, etc.)
-</pre>
-<p>As of 0.10.0 – you can generate test::unit or rspec test stubs via the <code>-T</code> or <code>--test-with</code> options. For example, <code>-T rspec</code> generates a <code>spec</code> folder with some test stubs.</p>
+* Update missing details (gem description, dependent gems, etc.)</pre>
+<p>You can generate test::unit or rspec test stubs via the <code>-T</code> or <code>--test-with</code> options. For example, <code>-T rspec</code> generates a <code>spec</code> folder with some test stubs.</p>
<h3>Setup</h3>
<p>Now modify the constants at the top of <strong>config/hoe.rb</strong>, with your name, email and the location where you’ll host your website for the gem. The defaults are tied to RubyForge for uploading the gems and the website (see below).</p>
<h3>Create code and tests</h3>
<p>Then create your libraries (files in <code>lib</code>) and your tests (files in <code>test</code> that look like <code>test_TESTNAME.rb</code>). <a href="http://blog.grayproductions.net/">James Edward Gray II</a> did a <a href="http://macromates.com/screencasts">nice video</a> on test-driven design, that’s worth watching if <span class="caps">TDD</span> is new to you.</p>
<p>If you create any new files, you need to manually add them to the Manifest.txt. Alphabetical order is optional, but it will make the results of <code>rake check_manifest</code> look clean if you keep them ordered. If a file is not in the Manifest.txt it will not be included in the gem when you package and release it.</p>
@@ -166,18 +163,26 @@
* Wizzos are the proper colour
* You only get Wizzos when you ask for them
</pre>
<p>The two paragraphs will be automatically picked up by the following release process and documented against the release on RubyForge site. To see an example of the end result, look at the <a href="http://newgem.rubyforge.org/rdoc/files/History_txt.html"><strong>History</strong> page for newgem</a>.</p>
<p>The History.txt notes for your first release have already been started for you.</p>
-<h3>Release the gem and upload the website and rdocs</h3>
-<p>Run <code>rake deploy VERSION=X.Y.Z</code> after you’ve done all these steps. It does the following:</p>
-<ol>
- <li>Uploads your website to rubyforge</li>
- <li>Uploads your rdocs to rubyforge</li>
- <li>Packages and uploads your gem to RubyForge</li>
-</ol>
-<p>It can take an hour or two before new gem releases are available via the gem installer. But when they are ready, everyone will be able to download and install your gem using:</p>
+<h3>Release the website (optional)</h3>
+<p>By default, <code>newgem</code> installs a one-page website to promote your RubyGem. (You can disable this <br />
+with the -W option). Once you have changed the gem version number, you can push the latest<br />
+website to rubyforge (or any target host) with a rake task.</p>
+<p>Check the file <code>config/website.yml</code> and give it your rubyforge username if necessary. Also, <br />
+if you want to put your website on a different host than rubyforge.org you can change the <br />
+<code>username@host</code> and <code>/path/to/www</code> in this file.</p>
+<p>Then rsync the website files with:</p>
+<pre>rake website</pre>
+<p>This will also generate RDocs and put them in the <code>doc</code> subfolder. Perhaps link to it in your<br />
+website.</p>
+<h3>Release the gem</h3>
+<p>Run <code>rake release VERSION=X.Y.Z</code> after you’ve done all these steps. It packages <br />
+and uploads your gem to RubyForge.</p>
+<p>It can take 20 minutes to an hour before new gem releases are available via the gem installer. <br />
+But when they are ready, everyone will be able to download and install your gem using:</p>
<pre>sudo gem install #gem_name#</pre>
<p>If your GEM_NAME and RUBYFORGE_PROJECT name are the same, then:</p>
<ul>
<li>http://RUBYFORGE_PROJECT.rubyforge.org is your website, and</li>
<li>http://RUBYFORGE_PROJECT.rubyforge.org/rdoc is your rdocs</li>
@@ -223,10 +228,10 @@
<h2>License</h2>
<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
<h2>Contact</h2>
<p>Comments are welcome. Send an email to <a href="mailto:drnicwilliams@gmail.com">Dr Nic Williams</a>.</p>
<p class="coda">
- <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 23rd September 2008<br>
+ <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 26th October 2008<br>
Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
</p>
</div>
<script type="text/javascript">