mirror of
https://github.com/nostalgic-css/NES.css.git
synced 2025-08-31 17:51:46 +02:00
docs(readme): add about how to install
This commit is contained in:
28
README.md
28
README.md
@@ -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
|
||||
|
||||
|
Reference in New Issue
Block a user