testing_please_ignore2 0.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +13 -0
- data/Rakefile +11 -0
- data/bin/testing_please_ignore2 +24 -0
- data/doc/api/all-methods.html +20 -0
- data/doc/api/all-namespaces.html +20 -0
- data/doc/api/app.js +18 -0
- data/doc/api/index.html +18 -0
- data/doc/api/jquery.js +11 -0
- data/doc/api/readme.html +35 -0
- data/doc/api/style.css +68 -0
- data/doc/api/syntax_highlight.css +21 -0
- data/doc/history.erb +66 -0
- data/doc/index.erb +7 -0
- data/doc/index.xhtml +1122 -0
- data/doc/intro.erb +83 -0
- data/doc/setup.erb +56 -0
- data/doc/theory.erb +3 -0
- data/doc/usage.erb +26 -0
- data/lib/testing_please_ignore2.rb +20 -0
- metadata +84 -0
data/doc/intro.erb
ADDED
@@ -0,0 +1,83 @@
|
|
1
|
+
<% chapter "Introduction" do %>
|
2
|
+
<% project_summary do %>
|
3
|
+
> TODO: explain the purpose of your project
|
4
|
+
|
5
|
+
****<%= $project %>**** is a __________ that __________.
|
6
|
+
<% end %>
|
7
|
+
|
8
|
+
> TODO: explain why your project is important
|
9
|
+
|
10
|
+
**<%= $project %>** is exciting because:
|
11
|
+
* It lets you __________.
|
12
|
+
* Its core contains less than __________ lines of code.
|
13
|
+
* It __________.
|
14
|
+
|
15
|
+
> TODO: explain why your project is better than its competitors
|
16
|
+
|
17
|
+
These features distinguish **<%= $project %>** from the competition:
|
18
|
+
* [competitor 1](http://)
|
19
|
+
* [competitor 2](http://)
|
20
|
+
* [competitor 3](http://)
|
21
|
+
|
22
|
+
<% paragraph "Etymology" do %>
|
23
|
+
> TODO: explain the meaning of the name of your project
|
24
|
+
<% end %>
|
25
|
+
|
26
|
+
<% section "Logistics" do %>
|
27
|
+
* <%= xref "History", "Release notes" %> --- history of project releases.
|
28
|
+
* [Source code](http://github.com/sun/<%= $program %>) --- obtain via [Git](http://git.or.cz) or browse online.
|
29
|
+
* [API reference](api/index.html) --- documentation for source code.
|
30
|
+
|
31
|
+
To get help or provide feedback, simply
|
32
|
+
<%= xref "License", "contact the author(s)" %>.
|
33
|
+
|
34
|
+
<% paragraph "Version numbers" do %>
|
35
|
+
**<%= $project %>** releases are numbered in *major.minor.patch*
|
36
|
+
form according to the [RubyGems rational versioning
|
37
|
+
policy](http://www.rubygems.org/read/chapter/7), which
|
38
|
+
can be summarized thus:
|
39
|
+
|
40
|
+
<table markdown="1">
|
41
|
+
<thead>
|
42
|
+
<tr>
|
43
|
+
<td rowspan="2">What increased in the version number?</td>
|
44
|
+
<td colspan="3">The increase indicates that the release:</td>
|
45
|
+
</tr>
|
46
|
+
<tr>
|
47
|
+
<th>Is backward compatible?</th>
|
48
|
+
<th>Has new features?</th>
|
49
|
+
<th>Has bug fixes?</th>
|
50
|
+
</tr>
|
51
|
+
</thead>
|
52
|
+
<tbody>
|
53
|
+
<tr>
|
54
|
+
<th>major</th>
|
55
|
+
<td style="background-color: #FFE4E1;">No</td>
|
56
|
+
<td>Yes</td>
|
57
|
+
<td>Yes</td>
|
58
|
+
</tr>
|
59
|
+
<tr>
|
60
|
+
<th>minor</th>
|
61
|
+
<td>Yes</td>
|
62
|
+
<td>Yes</td>
|
63
|
+
<td>Yes</td>
|
64
|
+
</tr>
|
65
|
+
<tr>
|
66
|
+
<th>patch</th>
|
67
|
+
<td>Yes</td>
|
68
|
+
<td style="background-color: #FFE4E1;">No</td>
|
69
|
+
<td>Yes</td>
|
70
|
+
</tr>
|
71
|
+
</tbody>
|
72
|
+
</table>
|
73
|
+
<% end %>
|
74
|
+
<% end %>
|
75
|
+
|
76
|
+
<% section "License" do %>
|
77
|
+
<%# include ../LICENSE #%>
|
78
|
+
<% end %>
|
79
|
+
|
80
|
+
<% section "Credits" do %>
|
81
|
+
> TODO: give attribution to your predecessors and contributors
|
82
|
+
<% end %>
|
83
|
+
<% end %>
|
data/doc/setup.erb
ADDED
@@ -0,0 +1,56 @@
|
|
1
|
+
<% chapter "Setup" do %>
|
2
|
+
<% section "Requirements" do %>
|
3
|
+
Your system needs the following software to run **<%= $project %>**.
|
4
|
+
|
5
|
+
| Software | Description | Notes |
|
6
|
+
| -------- | ----------- | ----- |
|
7
|
+
| [Ruby](http://ruby-lang.org) | Ruby language interpreter | Version 1.8.7 is required. |
|
8
|
+
| [RubyGems](http://rubygems.org) | Ruby packaging system | Version 1.3.1 is required. |
|
9
|
+
<% end %>
|
10
|
+
|
11
|
+
<% section "Installation" do %>
|
12
|
+
You can install **<%= $project %>** by running this command:
|
13
|
+
|
14
|
+
gem install <%= $program %>
|
15
|
+
|
16
|
+
To check whether the installation was sucessful, run this command:
|
17
|
+
|
18
|
+
<%= $program %> --version
|
19
|
+
|
20
|
+
If the installation was successful, you will see output like this:
|
21
|
+
|
22
|
+
<pre><%= verbatim `ruby bin/#{$program} --version` %></pre>
|
23
|
+
|
24
|
+
If you do not see such output, you may
|
25
|
+
<%= xref "License", "ask the author(s)" %> for help.
|
26
|
+
<% end %>
|
27
|
+
|
28
|
+
<% section "Manifest" do %>
|
29
|
+
You will see the following items inside **<%= $project %>**'s installation
|
30
|
+
directory, whose path you can determine by running this command:
|
31
|
+
|
32
|
+
<%= $program %> --version
|
33
|
+
|
34
|
+
> TODO: list important files your project provides here
|
35
|
+
|
36
|
+
* <tt>bin/</tt>
|
37
|
+
|
38
|
+
* <tt><%= $program %></tt> --- the main **<%= $project %>** executable.
|
39
|
+
|
40
|
+
* <tt>lib/</tt>
|
41
|
+
|
42
|
+
* <tt><%= $program %>.rb</tt> --- the main **<%= $project %>** library.
|
43
|
+
|
44
|
+
* <tt><%= $program %>/</tt>
|
45
|
+
|
46
|
+
> TODO: list sub-libraries your project provides here
|
47
|
+
|
48
|
+
* <tt>doc/</tt>
|
49
|
+
|
50
|
+
* <tt>api/</tt> --- API reference documentation.
|
51
|
+
|
52
|
+
* <tt>index.erb</tt> --- source of this user manual.
|
53
|
+
|
54
|
+
* <tt>LICENSE</tt> --- copyright notice and legal conditions.
|
55
|
+
<% end %>
|
56
|
+
<% end %>
|
data/doc/theory.erb
ADDED
data/doc/usage.erb
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
<% chapter "Usage" do %>
|
2
|
+
<% section "Command-line interface" do %>
|
3
|
+
When you run this command:
|
4
|
+
|
5
|
+
<%= $program %> --help
|
6
|
+
|
7
|
+
You will see this output:
|
8
|
+
|
9
|
+
<pre><%= verbatim `ruby bin/#{$program} --help` %></pre>
|
10
|
+
|
11
|
+
> TODO: explain the command-line arguments
|
12
|
+
<% end %>
|
13
|
+
|
14
|
+
<% section "Ruby library interface" do %>
|
15
|
+
> TODO: explain how to use your project's Ruby library
|
16
|
+
> from inside another Ruby program or library
|
17
|
+
<% end %>
|
18
|
+
|
19
|
+
<% section "Tutorial" do %>
|
20
|
+
This tutorial shows how **<%= $project %>** is used to __________.
|
21
|
+
|
22
|
+
> TODO: give examples for doing common tasks
|
23
|
+
<% end %>
|
24
|
+
|
25
|
+
> TODO: explain how to do more (advanced) things
|
26
|
+
<% end %>
|
@@ -0,0 +1,20 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
gem 'inochi', '~> 0'
|
3
|
+
require 'inochi'
|
4
|
+
|
5
|
+
Inochi.init :Testing_please_ignore2,
|
6
|
+
:project => 'TestingPleaseIgnore2',
|
7
|
+
:version => '0.0.0',
|
8
|
+
:release => '2009-01-18',
|
9
|
+
:website => 'http://testing_please_ignore2.rubyforge.org',
|
10
|
+
:tagline => 'TODO: put a single line description of your project here.',
|
11
|
+
:require => {
|
12
|
+
# TODO: list gems required by your project here.
|
13
|
+
# NOTE: this is completely optional!
|
14
|
+
#
|
15
|
+
# example: if your project needs version 9.9.9 of the 'foo' gem:
|
16
|
+
# 'foo' => '9.9.9',
|
17
|
+
#
|
18
|
+
# example: if any version of a gem is acceptable then:
|
19
|
+
# 'foo' => nil,
|
20
|
+
}
|
metadata
ADDED
@@ -0,0 +1,84 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: testing_please_ignore2
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Your Name
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
|
12
|
+
date: 2009-01-18 00:00:00 -08:00
|
13
|
+
default_executable:
|
14
|
+
dependencies:
|
15
|
+
- !ruby/object:Gem::Dependency
|
16
|
+
name: inochi
|
17
|
+
type: :runtime
|
18
|
+
version_requirement:
|
19
|
+
version_requirements: !ruby/object:Gem::Requirement
|
20
|
+
requirements:
|
21
|
+
- - "="
|
22
|
+
- !ruby/object:Gem::Version
|
23
|
+
version: 0.0.0
|
24
|
+
version:
|
25
|
+
description: "TODO: put a single line description of your project here."
|
26
|
+
email: your@email.here
|
27
|
+
executables:
|
28
|
+
- testing_please_ignore2
|
29
|
+
extensions: []
|
30
|
+
|
31
|
+
extra_rdoc_files: []
|
32
|
+
|
33
|
+
files:
|
34
|
+
- lib
|
35
|
+
- lib/testing_please_ignore2.rb
|
36
|
+
- Rakefile
|
37
|
+
- bin
|
38
|
+
- bin/testing_please_ignore2
|
39
|
+
- LICENSE
|
40
|
+
- doc
|
41
|
+
- doc/intro.erb
|
42
|
+
- doc/setup.erb
|
43
|
+
- doc/theory.erb
|
44
|
+
- doc/index.xhtml
|
45
|
+
- doc/api
|
46
|
+
- doc/api/syntax_highlight.css
|
47
|
+
- doc/api/style.css
|
48
|
+
- doc/api/jquery.js
|
49
|
+
- doc/api/all-methods.html
|
50
|
+
- doc/api/app.js
|
51
|
+
- doc/api/readme.html
|
52
|
+
- doc/api/all-namespaces.html
|
53
|
+
- doc/api/index.html
|
54
|
+
- doc/usage.erb
|
55
|
+
- doc/history.erb
|
56
|
+
- doc/index.erb
|
57
|
+
has_rdoc: true
|
58
|
+
homepage: http://testing_please_ignore2.rubyforge.org
|
59
|
+
post_install_message:
|
60
|
+
rdoc_options: []
|
61
|
+
|
62
|
+
require_paths:
|
63
|
+
- lib
|
64
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: "0"
|
69
|
+
version:
|
70
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - ">="
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: "0"
|
75
|
+
version:
|
76
|
+
requirements: []
|
77
|
+
|
78
|
+
rubyforge_project: sunaku
|
79
|
+
rubygems_version: 1.3.1
|
80
|
+
signing_key:
|
81
|
+
specification_version: 2
|
82
|
+
summary: "TODO: put a single line description of your project here."
|
83
|
+
test_files: []
|
84
|
+
|