Permalink
Browse files

README && LICENSE

  • Loading branch information...
1 parent 9f6ab5f commit 1007125295e8d79bff9e5381fe58f2bb820168fa @windyakin committed May 22, 2015
Showing with 109 additions and 2 deletions.
  1. +21 −0 LICENSE
  2. +88 −2 README.md
View
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 windyakin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
View
@@ -6,8 +6,94 @@
## About "Honoka"
-通常の[Bootstrap](http://getbootstrap.com/)では,日本語のフォント指定や文字サイズは最適とはいえません。
+通常の[Bootstrap](http://getbootstrap.com/)では,日本語のフォント指定や文字サイズは最適とはいえません。"Honoka"はそんなBootstrapをベースに,日本語表示に適したフォント指定や,文字サイズに関するコードを追記したBootstrapテーマの一つです。
## Usage
-基本的な使い方は本家のBootstrapとほとんど変わりません。ダウンロードしたフォルダ内にある ``bootstrap.min.css`` をHTMLにロードします。
+Honokaは単なるBootstrapテーマにしか過ぎないため,基本的な使い方は本家Bootstrapとほとんど変わりません。よって以下に書くことは[本家Bootstrap](http://getbootstrap.com/getting-started/)からの引用,もしくはその一部を変更したものです。用意されたCSSクラスやコンポーネントなど,より詳細な使い方のドキュメントは本家Bootstrapの各種リファレンスページ([CSS](http://getbootstrap.com/css/) / [Components](http://getbootstrap.com/components/) / [JavaScript](http://getbootstrap.com/javascript/))をご覧になることを推奨します。
+
+### Package
+
+配布しているzipファイルの内容物は以下のとおりです。``bootstrap.min.*``といったように,ファイル名に``min``がつくファイルは,改行やインデント・スペーシングをなくした(minifyされた)コードで,ユーザがウェブページを読み込む際の転送量を少なくすることができます。通常はこの``bootstrap.min.*``を使うことをおすすめします。
+
+```
+honoka/
+├─ bootstrap.html
+├─ css/
+│   ├─ bootstrap.css
+│   └─ bootstrap.min.css
+├─ fonts/
+│   ├─ glyphicons-halflings-regular.eot
+│   ├─ glyphicons-halflings-regular.svg
+│   ├─ glyphicons-halflings-regular.ttf
+│   ├─ glyphicons-halflings-regular.woff
+│   └─ glyphicons-halflings-regular.woff2
+└─ js/
+ ├─ bootstrap.js
+ └─ bootstrap.min.js
+```
+
+### Basic Template
+
+Bootstrapをつかってウェブページを作成する際に基本となるHTML部分は以下のようになります。CSSやJavaScriptのファイルパスは環境に合わせて変更する必要があります。
+
+```html
+<!DOCTYPE html>
+<html lang="ja">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
+ <title>Bootstrap 101 Template</title>
+
+ <!-- Bootstrap -->
+ <link href="css/bootstrap.min.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+ </head>
+ <body>
+ <h1>Hello, world!</h1>
+
+ <!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+ <!-- Include all compiled plugins (below), or include individual files as needed -->
+ <script src="js/bootstrap.min.js"></script>
+ </body>
+</html>
+```
+
+### Grunt
+
+このリポジトリはGruntを使った自動タスクによって,テストや配布用パッケージ生成することができます。
+
+```
+grunt server
+```
+
+テスト用サーバを起動します。``localhost:8000``に接続することで``dist/``以下のディレクトリをプレビューすることができます。また起動中にscssファイルを更新した場合,自動的にビルドされます(だがLive Reloadはされない)。
+
+```
+grunt build
+```
+
+Bootstrapに関連するファイルのビルドを行います。
+
+```
+grunt package
+```
+
+配布用パッケージを作成します。作成したファイルは``data/``ディレクトリ(``.gitignore``で無視ディレクトリに指定)の``bootstrap-honoka-dist.zip``へ出力されます。
+
+## License
+
+[MIT Licesne](LICENSE)
+
+## Author
+
+ * windyakin ([windyakin.net](http://windyakin.net/))

0 comments on commit 1007125

Please sign in to comment.