Skip to content

Commit 2226fda

Browse files
hsbthsbt
committed
Merge pull request #9 from nico-hn/readmes_in_md
add READMEs in GFM
2 parents 92d4744 + 6a6f07c commit 2226fda

File tree

2 files changed

+226
-0
lines changed

2 files changed

+226
-0
lines changed

‎README.ja.md

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# HikiDoc
2+
3+
## はじめに
4+
5+
'HikiDoc' は「テキスト→ HTML」変換ツールです。書きやすく読みやすい文法の
6+
テキストをまともな HTML (や XHTML) に変換します。
7+
8+
## 必要なもの
9+
10+
HikiDoc の実行には Ruby 1.8.2 以降が必要です。
11+
12+
## ダウンロード
13+
14+
GitHub レポジトリ [https://github.com/hiki/hikidoc](https://github.com/hiki/hikidoc) から取得して
15+
ください。
16+
17+
```
18+
(例)
19+
git clone https://github.com/hiki/hikidoc.git
20+
```
21+
22+
## インストール
23+
24+
### 半手動でのインストール
25+
26+
以下のように 'setup.rb' スクリプトを用いてインストールします。
27+
28+
```
29+
$ ruby setup.rb config
30+
$ ruby setup.rb setup
31+
# ruby setup.rb install
32+
```
33+
34+
### RubyGems経由でのインストール
35+
36+
以下のようにインストールします。
37+
38+
```
39+
$ gem install hikidoc
40+
```
41+
42+
## 文法
43+
44+
[TextFormattingRules.ja](TextFormattingRules.ja) をご覧ください。
45+
46+
## メーリングリスト
47+
48+
参加を希望される方は、以下のようなメールを送信してください。
49+
50+
```
51+
To: [email protected]
52+
Cc: [email protected]
53+
54+
本文に自己紹介など
55+
```
56+
57+
過去のメールは [http://www.fdiary.net/ml/hikidoc/](http://www.fdiary.net/ml/hikidoc/) で公開しています。
58+
59+
## 関連するソフトウェア
60+
61+
以下のソフトウェアで HikiDoc ライブラリ、または HikiDoc フォーマットが用いられています。
62+
63+
<dl>
64+
<dt><a href="http://www.tdiary.org/">tDiary</a></dt>
65+
<dd>ウェブ日記ソフトウェア</dd>
66+
<dt><a href="http://hikiwiki.org/">Hiki</a></dt>
67+
<dd>多機能かつ高速な Wiki クローン</dd>
68+
<dt><a href="http://lily.sourceforge.jp/">lily</a></dt>
69+
<dd>シンプルな CMS (Web サイト構築システム)</dd>
70+
<dt><a href="http://search.cpan.org/perldoc?Text::HikiDoc">Text::HikiDoc</a></dt>
71+
<dd>Perl による HikiDoc の実装</dd>
72+
<dt><a href="http://github.com/moro/piki_doc/">PikiDoc</a></dt>
73+
<dd>HikiDocの「プラグイン」機能を追加できるライブラリです</dd>
74+
<dt><a href="http://sourceforge.jp/projects/mail2weblog/wiki/FrontPage">mail2weblog</a></dt>
75+
<dd>高機能メール投稿型モブログ</dd>
76+
</dl>
77+
78+
## ライセンス
79+
80+
Modified BSD ライセンスです。
81+
82+
```
83+
Copyright (c) 2005, Kazuhiko <[email protected]>
84+
All rights reserved.
85+
86+
Redistribution and use in source and binary forms, with or without
87+
modification, are permitted provided that the following conditions are
88+
met:
89+
90+
* Redistributions of source code must retain the above copyright
91+
notice, this list of conditions and the following disclaimer.
92+
* Redistributions in binary form must reproduce the above
93+
copyright notice, this list of conditions and the following
94+
disclaimer in the documentation and/or other materials provided
95+
with the distribution.
96+
* Neither the name of the HikiDoc nor the names of its
97+
contributors may be used to endorse or promote products derived
98+
from this software without specific prior written permission.
99+
100+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
101+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
102+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
103+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
104+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
105+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
106+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
107+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
108+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
109+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
110+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
111+
```
112+

‎README.md

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# HikiDoc
2+
3+
## Introduction
4+
5+
'HikiDoc' is a text-to-HTML conversion tool for web writers. HikiDoc
6+
allows you to write using an easy-to-read, easy-to-write plain text
7+
format, then convert it to structurally valid HTML (or XHTML).
8+
9+
## Requirements
10+
11+
HikiDoc requires Ruby 1.8.2 or later.
12+
13+
## Download
14+
15+
Get from the GitHub repository [https://github.com/hiki/hikidoc](https://github.com/hiki/hikidoc)
16+
17+
```
18+
(eg.)
19+
git clone https://github.com/hiki/hikidoc.git
20+
```
21+
22+
## Installation
23+
24+
### Semi-manual installation
25+
26+
Run the 'setup.rb' script like so:
27+
28+
```
29+
$ ruby setup.rb config
30+
$ ruby setup.rb setup
31+
# ruby setup.rb install
32+
```
33+
34+
### Installation via RubyGems
35+
36+
Run the following command:
37+
38+
```
39+
$ gem install hikidoc
40+
```
41+
42+
## Syntax
43+
44+
See [TextFormattingRules](TextFormattingRules).
45+
46+
## Mailing list
47+
48+
To subscribe the HikiDoc ML, please send the following mail. English
49+
posts are also welcome.
50+
51+
```
52+
To: [email protected]
53+
Cc: [email protected]
54+
Subject: subscribe <- any subject
55+
56+
Hello. <- any body
57+
```
58+
59+
HikiDoc ML's archive is available at [http://www.fdiary.net/ml/hikidoc/](http://www.fdiary.net/ml/hikidoc/) .
60+
61+
## Related softwares
62+
63+
The following softwares use the HikiDoc library or the HikiDoc format.
64+
65+
<dl>
66+
<dt><a href="http://www.tdiary.org/">tDiary</a></dt>
67+
<dd>a Weblog/Web-diary software</dd>
68+
<dt><a href="http://hikiwiki.org/">Hiki</a></dt>
69+
<dd>a powerful and fast wiki clone</dd>
70+
<dt><a href="http://lily.sourceforge.jp/">lily</a></dt>
71+
<dd>a simple CMS</dd>
72+
<dt><a href="http://search.cpan.org/perldoc?Text::HikiDoc">Text::HikiDoc</a></dt>
73+
<dd>HikiDoc by Perl</dd>
74+
<dt><a href="http://github.com/moro/piki_doc/">PikiDoc</a></dt>
75+
<dd>a library that you can add plugin functions on HikiDoc</dd>
76+
<dt><a href="http://sourceforge.jp/projects/mail2weblog/wiki/FrontPage">mail2weblog</a></dt>
77+
<dd>a blog system via mobile phone email</dd>
78+
</dl>
79+
80+
## License
81+
82+
HikiDoc's license is the 'Modified BSD License'.
83+
84+
```
85+
Copyright (c) 2005, Kazuhiko <[email protected]>
86+
All rights reserved.
87+
88+
Redistribution and use in source and binary forms, with or without
89+
modification, are permitted provided that the following conditions are
90+
met:
91+
92+
* Redistributions of source code must retain the above copyright
93+
notice, this list of conditions and the following disclaimer.
94+
* Redistributions in binary form must reproduce the above
95+
copyright notice, this list of conditions and the following
96+
disclaimer in the documentation and/or other materials provided
97+
with the distribution.
98+
* Neither the name of the HikiDoc nor the names of its
99+
contributors may be used to endorse or promote products derived
100+
from this software without specific prior written permission.
101+
102+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
103+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
104+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
105+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
106+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
107+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
108+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
109+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
110+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
111+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
112+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
113+
```
114+

0 commit comments

Comments
 (0)