website/index.txt in rocketstarter-0.0.1 vs website/index.txt in rocketstarter-0.0.2
- old
+ new
@@ -1,40 +1,91 @@
h1. rocket starter
h1. → 'rocketstarter'
+"Here is Japanese version of manual.":http://fromnorth.blogspot.com/2008/06/rubygemrocket-starter.html
-h2. What
+h2. What is this?
+This gem is tool for creating new rails application.<br />
+The Rocket-starter can set up basic directories and svn/git repositories for your applications when you want to start it.<br />
+If you want, you can use the git and the RaPT gem and a list of plugins.<br />
-h2. Installing
+h2. Features
-<pre syntax="ruby">sudo gem install rocketstarter</pre>
+* create basic directories<br />
+* commit to subversion or git repositories<br />
+* set svn:ignore property or .gitignore file.<br />
+* install plugins<br />
+* use RaPT gem for managing plugins (Optional)<br />
+* write password to config/database.yml<br />
+* create databases before finish by 'rake db:create:all' command<br />
-h2. The basics
+h2. Installing
+<pre syntax="ruby">gem install rocketstarter</pre>
h2. Demonstration of usage
+<pre syntax="ruby">
+Usage: rocket_starter project-name [options]
+Usage: rocket_starter --init [options]
+Usage: rocket_starter --check [options]
+and more...
+Usage: rocket_starter --help
+</pre>
+h2. How to use
-h2. Forum
+1. Set environment valiable if you want to change a config file path.
-"http://groups.google.com/group/rocket-starter":http://groups.google.com/group/rocket-starter
+<pre syntax="ruby">
+$ export ROCKET_STARTER_CONF=~/.rocket_starter
+</pre>
-TODO - create Google Group - rocket-starter
+2. Create config file.
-h2. How to submit patches
+<pre syntax="ruby">
+$ rocketstarter --init
+</pre>
-Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+3. Modify default values and plugin list.
-TODO - pick SVN or Git instructions
+<pre syntax="ruby">
+$ vi ~/.rocket_starter
+$ vi ~/useful_plugins
+</pre>
-The trunk repository is <code>svn://rubyforge.org/var/svn/rocketstarter/trunk</code> for anonymous access.
+4. Test for setting
-OOOORRRR
+<pre syntax="ruby">
+$ rocketstarter --check
+</pre>
+5. Create project.
+
+<pre syntax="ruby">
+$ cd source-dir
+$ rocketstarter project_name
+</pre>
+
+6. Execute sqld4r if you want
+
+<pre syntax="ruby">
+$ cd project_name/rails/project_name
+$ sqld4r /path/to/DBDesigner.xml
+</pre>
+
+
+h2. Forum
+
+"http://groups.google.com/group/rocket-starter":http://groups.google.com/group/rocket-starter
+
+h2. How to submit patches
+
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+
You can fetch the source from either:
<% if rubyforge_project_id %>
* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>
@@ -52,27 +103,14 @@
Or you can hack website/index.txt and make it all go away!!
<% end %>
-* github: "http://github.com/GITHUB_USERNAME/rocketstarter/tree/master":http://github.com/GITHUB_USERNAME/rocketstarter/tree/master
-
-<pre>git clone git://github.com/GITHUB_USERNAME/rocketstarter.git</pre>
-
-
-TODO - add "github_username: username" to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.
-
-
-* gitorious: "git://gitorious.org/rocketstarter/mainline.git":git://gitorious.org/rocketstarter/mainline.git
-
-<pre>git clone git://gitorious.org/rocketstarter/mainline.git</pre>
-
h3. Build and test instructions
<pre>cd rocketstarter
rake test
rake install_gem</pre>
-
h2. License
This code is free to use under the terms of the MIT license.