-
Notifications
You must be signed in to change notification settings - Fork 0
/
developer.html
147 lines (138 loc) · 6.54 KB
/
developer.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="ja" xml:lang="ja">
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="ranguba.css" type="text/css" />
<link rel="shortcut icon" href="/favicon.ico" />
<link rel="icon" href="/favicon.png" />
<title>Deveroper - Ranguba</title>
</head>
<body>
<div class="header">
<div class="title">
<a href="./">
<span class="title">Developer</span>
<span class="title-separator">-</span>
<span class="title-project">Ranguba</span>
</a>
</div>
<ul class="other-languages">
<li id="other-language-japanese" lang="ja" xml:lang="ja"><a href="ja/developer.html">日本語</a></li>
</ul>
<ul class="menu">
<li id="menu-reference"><a href="rroonga/en/">Reference Manual</a></li>
<li id="menu-tutorial"><a href="rroonga/en/file.tutorial.html">Tutorial</a></li>
<li id="menu-install"><a href="./#install-rroonga">Install</a></li>
<li id="menu-developer"><a href="developer.html">Developer</a></li>
</ul>
</div>
<div class="content">
<div class="main">
<h1>Developer</h1>
<p>
Please join us to use Groonga using Ruby more usefully.
We provided information needed for development.
</p>
<h2 id="repository">Repository</h2>
<p>
There are repositories of Rroonga, ActiveGroonga, ActiveGroonga Fabrication, racknga, ChupaText, and Document Search Ranguba in GitHub.
Please see below for check-out each repositories by git.
</p>
<dl>
<dt><a href="http://github.com/ranguba/rroonga/">Rroonga</a></dt>
<dd><pre class="command">% git clone git://github.com/ranguba/rroonga.git</pre></dd>
<dt><a href="http://github.com/ranguba/activegroonga/">ActiveGroonga</a></dt>
<dd><pre class="command">% git clone git://github.com/ranguba/activegroonga.git</pre></dd>
<dt><a href="http://github.com/ranguba/activegroonga-fabrication/">ActiveGroonga Fabrication</a></dt>
<dd><pre class="command">% git clone git://github.com/ranguba/activegroonga-fabrication.git</pre></dd>
<dt><a href="http://github.com/ranguba/racknga/">racknga</a></dt>
<dd><pre class="command">% git clone git://github.com/ranguba/racknga.git</pre></dd>
<dt><a href="http://github.com/ranguba/chupa-text/">ChupaText</a></dt>
<dd><pre class="command">% git clone git://github.com/ranguba/chupa-text.git</pre></dd>
<dt><a href="http://github.com/ranguba/ranguba/">Document Search Ranguba</a></dt>
<dd><pre class="command">% git clone git://github.com/ranguba/ranguba.git</pre></dd>
</dl>
<p>
Sample program of Rroonga, ActiveGroonga, ActiveGroonga Fabrication, racknga and ChupaText are also contained each repositories.
Please see below for check-out these program.
</p>
<dl>
<dt><a href="http://github.com/ranguba/examples/">Sample</a></dt>
<dd><pre class="command">% git clone git://github.com/ranguba/examples.git</pre></dd>
</dl>
<h2 id="how-to-build">How to build</h2>
<p>
You should use extconf.rb and Makefile to build Rroonga, so don't use Rakefile.
</p>
<p>
Please run extconf.rb with ruby you want to use Rroonga, and run make command.
</p>
<pre class="command">% ruby extconf.rb
% make</pre>
<p>
You can get ext/groonga/groonga.so if make command for Rroonga succeeded.
If you want to use Groonga without installing it, you may set $LOAD_PATH following before use Groonga by "require" method.
</p>
<pre class="command">% irb -I lib -I ext/groonga -r groonga</pre>
<h2 id="contact">Contact</h2>
<p>
If you find bugs, please show us by <a href="http://lists.sourceforge.jp/mailman/listinfo/groonga-dev">mailinglist of Groonga</a> or <a href="http://redmine.groonga.org/projects/rroonga/issues/new">Redmine</a>.
Please also send mail to Groonga mailinglist for asking questions, giving idea, sending patch, and so on.
</p>
<h2 id="commit-mail">Commit-mail</h2>
<p>
When someone commit to a repository, you can get mail including difference of this commit from <a href="http://rubyforge.org/mailman/listinfo/groonga-commit">mailinglist for groonga-commit</a>.
If you're interested in development of Groonga, please subscribe this mailinglist.
</p>
<h2 id="document">Document</h2>
<p>
Documents are described in each source code by YARD.
Created documents are translated to HTML, and published as <a href="rroonga/">Reference Manual</a>.
</p>
<p>
We want to provide document page in English and Japanese, but now some page is wrote in Japanese only, sorry.
Documents in Japanese are included source code directly.
We're recruiting those who help us to make how to create reference manual translated in many language by YARD or to create documents in English.
</p>
<p>
In <a href="http://redmine.groonga.org/projects/show/rroonga">Redmine</a>, we also provide <a href="http://redmine.groonga.org/wiki/rroonga">Wiki</a> containing documents.
Wiki focuses of information not to be wrote in reference manual.
If you have tips or related information for Ranguba project, please send them to <a href="#contact">mailinglist</a> or edit wiki after subscribe Redmine.
</p>
</div>
<div class="sidebar">
<ul>
<li><a href="http://ranguba.org/">Project page</a></li>
<li>
<a href="http://lists.sourceforge.net/mailman/listinfo/groonga-talk">Mailinglist</a>
</li>
</ul>
</div>
</div>
<div class="sponsors">
<p id="sponsor-rubyforge">
<a href="http://rubyforge.org/projects/groonga/">
<img src="rubyforge.png" width="120" height="24" border="0" alt="Test::Unit is hosted on RubyForge.org." />
</a>
</p>
<p id="sponsor-github">
<a href="https://github.com/ranguba/">
<img src="github-logo.png" width="100" height="45" border="0" alt="GitHub's git repositories are used." />
</a>
</p>
<p id="sponsor-tango">
<a href="http://tango.freedesktop.org/">
<img width="120" height="53" border="0" alt="Tango Desktop Project's icons are used." src="tango-logo.png" />
</a>
</p>
<p id="sponsor-famfamfam">
<a href="http://www.famfamfam.com/">
<img width="120" height="18" border="0" alt="famfamfam.com's flags are used." src="famfamfam-logo.png" />
</a>
</p>
</div>
</body>
</html>