1
0
mirror of https://github.com/nostalgic-css/NES.css.git synced 2025-04-20 22:22:05 +02:00

docs(readme): add about how to install

This commit is contained in:
BcRikko 2020-03-16 15:42:56 +09:00
parent e13d062735
commit 33b6538072
6 changed files with 174 additions and 17 deletions

30
.github/README-es.md vendored
View File

@ -26,6 +26,32 @@ Nuestro `package.json` contiene metadata adicional bajo las siguientes keys:
* `sass` - Ruta a nuestro archivo fuente principal de Sass
* `style` - Ruta a nuestro CSS no minificado
##### AltCSS(sass, scss...)
```scss
// style.scss
@import "./node_modules/nes.css/css/nes.css"
```
##### JavaScript
```js
// script.js
import "nes.css/css/nes.min.css";
```
Necesita instalar css-loader.
##### HTML
```html
<!-- index.html -->
<html>
<head>
<link rel="stylesheet" href="./node_modules/nes.css/css/nes.min.css">
</head>
<body></body>
</html>
```
#### Vía CDN
Importa el CSS utiliando un elemento `<link />`:
@ -47,10 +73,10 @@ NES.css no contiene ninguna tipografía, pero recomendamos la siguiente lista de
| --------- | ------------------------------------------------------------------ |
| (Default) | [Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P) |
| Inglés | [Kongtext](https://www.dafont.com/kongtext.font) |
| Chinoés | [Zpix (最像素)](https://github.com/SolidZORO/zpix-pixel-font) |
| Japonés | [美咲フォント](http://littlelimit.net/misaki.htm) |
| Japonés | [Nu もち](http://kokagem.sakura.ne.jp/font/mochi/) |
| Coreano | [둥근모꼴](http://cactus.tistory.com/193) |
| Coreano | [둥근모꼴](http://cactus.tistory.com/193) |
| Chinoés | [Zpix (最像素)](https://github.com/SolidZORO/zpix-pixel-font) |
## Uso

31
.github/README-jp.md vendored
View File

@ -26,6 +26,33 @@ yarn add nes.css
* `sass` - メインのSassソースファイルへのパス
* `style` - 非圧縮のCSSへのパス
##### AltCSS(sass, scss...)
```scss
// style.scss
@import "./node_modules/nes.css/css/nes.css"
```
##### JavaScript
```js
// script.js
import "nes.css/css/nes.min.css";
```
css-loaderが必要です。
##### HTML
```html
<!-- index.html -->
<html>
<head>
<link rel="stylesheet" href="./node_modules/nes.css/css/nes.min.css">
</head>
<body></body>
</html>
```
#### CDNを使う場合
`<link />`要素を使ってCSSをインポートする:
@ -46,11 +73,11 @@ NES.cssはいかなるフォントも提供していませんが、ライブラ
| 言語 | フォント |
| ------------ | ------------------------------------------------------------------ |
| (デフォルト) | [Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P) |
| 中国語 | [Zpix (最像素)](https://github.com/SolidZORO/zpix-pixel-font) |
| 英語 | [Kongtext](https://www.dafont.com/kongtext.font) |
| 日本語 | [美咲フォント](http://littlelimit.net/misaki.htm) |
| 日本語 | [Nu もち](http://kokagem.sakura.ne.jp/font/mochi/) |
| 韓国語 | [둥근모꼴](http://cactus.tistory.com/193) |
| 韓国語 | [둥근모꼴](http://cactus.tistory.com/193) |
| 中国語 | [Zpix (最像素)](https://github.com/SolidZORO/zpix-pixel-font) |
## 使い方

View File

@ -26,6 +26,32 @@ Nosso `package.json` contém alguns metadata adicionais, sob as seguintes chaves
* `sass` - caminho para nosso arquivo de código fonte principal Sass
* `style` - caminho para nosso CSS não-minificado
##### AltCSS(sass, scss...)
```scss
// style.scss
@import "./node_modules/nes.css/css/nes.css"
```
##### JavaScript
```js
// script.js
import "nes.css/css/nes.min.css";
```
Você precisa instalar o css-loader.
##### HTML
```html
<!-- index.html -->
<html>
<head>
<link rel="stylesheet" href="./node_modules/nes.css/css/nes.min.css">
</head>
<body></body>
</html>
```
### via CDN
Importe o CSS através de um elemento `<link />`:
@ -47,10 +73,10 @@ NES.css não fornece nenhuma fonte, mas nós mantemos uma lista de fontes recome
| -------- | ------------------------------------------------------------------ |
| (Padrão) | [Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P) |
| Inglês | [Kongtext](https://www.dafont.com/kongtext.font) |
| Chinês | [Zpix (最像素)](https://github.com/SolidZORO/zpix-pixel-font) |
| Japonês | [美咲フォント](http://littlelimit.net/misaki.htm) |
| Japonês | [Nu もち](http://kokagem.sakura.ne.jp/font/mochi/) |
| Coreano | [둥근모꼴](http://cactus.tistory.com/193) |
| Coreano | [둥근모꼴](http://cactus.tistory.com/193) |
| Chinês | [Zpix (最像素)](https://github.com/SolidZORO/zpix-pixel-font) |
## Utilização

30
.github/README-ru.md vendored
View File

@ -26,6 +26,32 @@ yarn add nes.css
* `sass` - Путь до главного Sass файла
* `style` - Путь до неминифицированного CSS
##### AltCSS(sass, scss...)
```scss
// style.scss
@import "./node_modules/nes.css/css/nes.css"
```
##### JavaScript
```js
// script.js
import "nes.css/css/nes.min.css";
```
Вам необходимо установить css-загрузчик.
##### HTML
```html
<!-- index.html -->
<html>
<head>
<link rel="stylesheet" href="./node_modules/nes.css/css/nes.min.css">
</head>
<body></body>
</html>
```
#### Через CDN
Использования через тэг `<link />`:
@ -47,10 +73,10 @@ NES.css не предоставляет никаких шрифтов, но мы
| ------------ | ------------------------------------------------------------------ |
| По умолчанию | [Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P) |
| Английский | [Kongtext](https://www.dafont.com/kongtext.font) |
| китайский | [Zpix (最像素)](https://github.com/SolidZORO/zpix-pixel-font) |
| Японский | [美咲フォント](http://littlelimit.net/misaki.htm) |
| Японский | [Nu もち](http://kokagem.sakura.ne.jp/font/mochi/) |
| Корейский | [둥근모꼴](http://cactus.tistory.com/193) |
| Корейский | [둥근모꼴](http://cactus.tistory.com/193) |
| китайский | [Zpix (最像素)](https://github.com/SolidZORO/zpix-pixel-font) |
## Использование

View File

@ -18,6 +18,32 @@ npm install nes.css
yarn add nes.css
```
##### AltCSS(sass, scss...)
```scss
// style.scss
@import "./node_modules/nes.css/css/nes.css"
```
##### JavaScript
```js
// script.js
import "nes.css/css/nes.min.css";
```
您需要安装css加载程序.
##### HTML
```html
<!-- index.html -->
<html>
<head>
<link rel="stylesheet" href="./node_modules/nes.css/css/nes.min.css">
</head>
<body></body>
</html>
```
### via CDN
```html
@ -31,14 +57,14 @@ yarn add nes.css
### 推荐字体
| 语言 | 字体 |
| --------- | ------------------------------------------------------------------ |
| (默认) | [Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P) |
| 英语 | [Kongtext](https://www.dafont.com/kongtext.font) |
| 中文 | [Zpix (最像素)](https://github.com/SolidZORO/zpix-pixel-font) |
| 日语 | [美咲フォント](http://littlelimit.net/misaki.htm) |
| 日语 | [Nu もち](http://kokagem.sakura.ne.jp/font/mochi/) |
| 韩语 | [둥근모꼴](http://cactus.tistory.com/193) |
| 语言 | 字体 |
| ------ | ------------------------------------------------------------------ |
| (默认) | [Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P) |
| 英语 | [Kongtext](https://www.dafont.com/kongtext.font) |
| 日语 | [美咲フォント](http://littlelimit.net/misaki.htm) |
| 日语 | [Nu もち](http://kokagem.sakura.ne.jp/font/mochi/) |
| 韩语 | [둥근모꼴](http://cactus.tistory.com/193) |
| 中文 | [Zpix (最像素)](https://github.com/SolidZORO/zpix-pixel-font) |
## 使用

View File

@ -26,6 +26,32 @@ Our `package.json` contains some additional metadata under the following keys:
* `sass` - path to our main Sass source file
* `style` - path to our non-minified CSS
##### AltCSS(sass, scss...)
```scss
// style.scss
@import "./node_modules/nes.css/css/nes.css"
```
##### JavaScript
```js
// script.js
import "nes.css/css/nes.min.css";
```
You need to install css-loader.
##### HTML
```html
<!-- index.html -->
<html>
<head>
<link rel="stylesheet" href="./node_modules/nes.css/css/nes.min.css">
</head>
<body></body>
</html>
```
#### via CDN
Import the CSS via a `<link />` element:
@ -46,11 +72,11 @@ NES.css doesn't provide any fonts, but we do maintain the following list of font
| Language | Font |
| --------- | ------------------------------------------------------------------ |
| (Default) | [Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P) |
| Chinese | [Zpix (最像素)](https://github.com/SolidZORO/zpix-pixel-font) |
| English | [Kongtext](https://www.dafont.com/kongtext.font) |
| Japanese | [美咲フォント](http://littlelimit.net/misaki.htm) |
| Japanese | [Nu もち](http://kokagem.sakura.ne.jp/font/mochi/) |
| Korean | [둥근모꼴](http://cactus.tistory.com/193) |
| Chinese | [Zpix (最像素)](https://github.com/SolidZORO/zpix-pixel-font) |
## Usage