diff --git a/README-jp.md b/README-jp.md new file mode 100644 index 0000000..bbcd74a --- /dev/null +++ b/README-jp.md @@ -0,0 +1,99 @@ +
+ NES.css: NES-style  CSS framework + + English / 日本語 +
+ +NES.cssは **ファミコン風(8bit ライク)** なCSSフレームワークです。 + + +## Install + +### CDN + +```html + + + + +``` + +OR + +```html + + + + +``` + +### 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. diff --git a/README.md b/README.md index 0b1eacd..b25a763 100644 --- a/README.md +++ b/README.md @@ -85,21 +85,21 @@ pre-commit hookにより、コミット時に自動でLint→format→buildが 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 overwrite reboot.css - | |- variables.scss: Common variables - |- elements - |- form - |- icons: For 16x16 icon - |- pixel-arts: For icon other than 16x16 icon. - |- utilities +├── 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 ```