mirror of
https://github.com/nostalgic-css/NES.css.git
synced 2025-09-02 02:22:37 +02:00
Added README-jp.md
This commit is contained in:
99
README-jp.md
Normal file
99
README-jp.md
Normal file
@@ -0,0 +1,99 @@
|
|||||||
|
<div align="center">
|
||||||
|
<a href="https://bcrikko.github.io/NES.css/" target="_blank"><img src="https://user-images.githubusercontent.com/5305599/49061716-da649680-f254-11e8-9a89-d95a7407ec6a.png" alt="NES.css: NES-style CSS framework" style="max-width:100%;" width="600" height="315"></a>
|
||||||
|
|
||||||
|
<a href="README.md">English</a> / <a href="README-jp.md">日本語</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
NES.cssは **ファミコン風(8bit ライク)** なCSSフレームワークです。
|
||||||
|
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
### CDN
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!-- minify -->
|
||||||
|
<link href="https://unpkg.com/nes.css@0.0.2/css/nes.min.css" rel="stylesheet" />
|
||||||
|
<!-- latest -->
|
||||||
|
<link href="https://unpkg.com/nes.css/css/nes.min.css" rel="stylesheet" />
|
||||||
|
```
|
||||||
|
|
||||||
|
OR
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!-- non-minified -->
|
||||||
|
<link href="https://unpkg.com/nes.css@0.0.2/css/nes.css" rel="stylesheet" />
|
||||||
|
<!-- latest -->
|
||||||
|
<link href="https://unpkg.com/nes.css/css/nes.css" rel="stylesheet" />
|
||||||
|
```
|
||||||
|
|
||||||
|
### npm
|
||||||
|
|
||||||
|
TODO: npm での使用方法を書く
|
||||||
|
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
NES.cssはコンポーネントのスタイルのみを提供しています。レイアウトはみなさんが好きなように定義してください。
|
||||||
|
|
||||||
|
デフォルトでは`Press Start 2P`フォントを使っています。英語以外(日本語など)で利用される場合は、別途フォントを読み込んで使ってください。
|
||||||
|
|
||||||
|
TODO: 詳細を書く
|
||||||
|
|
||||||
|
|
||||||
|
## CSS Only
|
||||||
|
|
||||||
|
NES.cssはCSSのみで構成されています。JavaScriptは不要です。
|
||||||
|
|
||||||
|
|
||||||
|
## Browser Support
|
||||||
|
|
||||||
|
次のブラウザの最新バージョンをサポートしています。
|
||||||
|
|
||||||
|
* Chrome
|
||||||
|
* Firefox
|
||||||
|
* Safari
|
||||||
|
|
||||||
|
未確認
|
||||||
|
* IE/Edge
|
||||||
|
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
### Commands
|
||||||
|
```sh
|
||||||
|
git clone git@github.com:BcRikko/NES.css.git
|
||||||
|
cd NES.css
|
||||||
|
|
||||||
|
npm i
|
||||||
|
|
||||||
|
npm run watch
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
pre-commit hookにより、コミット時に自動でLint→format→buildが走り、`css`ディレクトリにファイルが出力されます。
|
||||||
|
TODO: ビルドはCIでするように変更したい
|
||||||
|
|
||||||
|
### Directories
|
||||||
|
```sh
|
||||||
|
.
|
||||||
|
├── index.html: Demo page
|
||||||
|
├── style.css: Demo page style
|
||||||
|
├── css: Distribution files
|
||||||
|
└── scss: Source
|
||||||
|
├── base
|
||||||
|
│ ├── reboot.scss: Don't change! (Bootstrap Reboot)
|
||||||
|
│ ├── generic.scss: Generic style and reboot.css
|
||||||
|
│ └── variables.scss: Common variables
|
||||||
|
├── elements
|
||||||
|
├── form
|
||||||
|
├── icons: 16x16 icons
|
||||||
|
├── pixel-arts: For icons other than 16x16.
|
||||||
|
└── utilities
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Copyright and license
|
||||||
|
|
||||||
|
Code and documentation copyright 2018 [B.C.Rikko](https://github.com/BcRikko). Code released under the MIT License. Docs released under Creative Commons.
|
28
README.md
28
README.md
@@ -85,21 +85,21 @@ pre-commit hookにより、コミット時に自動でLint→format→buildが
|
|||||||
TODO: ビルドはCIでするように変更したい
|
TODO: ビルドはCIでするように変更したい
|
||||||
|
|
||||||
### Directories
|
### Directories
|
||||||
```
|
```sh
|
||||||
.
|
.
|
||||||
|- index.html: Demo page
|
├── index.html: Demo page
|
||||||
|- style.css: Demo page style
|
├── style.css: Demo page style
|
||||||
|- css: Distribution files
|
├── css: Distribution files
|
||||||
|- scss: Source
|
└── scss: Source
|
||||||
|- base
|
├── base
|
||||||
| |- reboot.scss: **Don't change!** (Bootstrap Reboot)
|
│ ├── reboot.scss: Don't change! (Bootstrap Reboot)
|
||||||
| |- generic.scss: Generic style and overwrite reboot.css
|
│ ├── generic.scss: Generic style and reboot.css
|
||||||
| |- variables.scss: Common variables
|
│ └── variables.scss: Common variables
|
||||||
|- elements
|
├── elements
|
||||||
|- form
|
├── form
|
||||||
|- icons: For 16x16 icon
|
├── icons: 16x16 icons
|
||||||
|- pixel-arts: For icon other than 16x16 icon.
|
├── pixel-arts: For icons other than 16x16.
|
||||||
|- utilities
|
└── utilities
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user