mirror of
https://github.com/ekmas/cs16.css
synced 2026-04-10 21:53:24 +00:00
Update README.md
This commit is contained in:
parent
ad77e30568
commit
c8d41b08bd
1 changed files with 56 additions and 1 deletions
55
README.md
55
README.md
|
|
@ -14,6 +14,61 @@ You can install cs16.css simply by pasting this to your html `head` tag:
|
|||
|
||||
or you can download css file and font from this repo. Inside css folder are prefixed and minified versions of cs16.css you can use.
|
||||
|
||||
## Contributing
|
||||
|
||||
Thank you for wanting to contribute to this project. Here you can learn how to do it.
|
||||
|
||||
### Project structure
|
||||
|
||||
```
|
||||
ArialPixel.ttf
|
||||
index.html
|
||||
package.json
|
||||
└── src
|
||||
├── cs16.css
|
||||
├── index.css
|
||||
├── main.js
|
||||
└── css
|
||||
├── cs16.css
|
||||
├── cs16.min.css
|
||||
```
|
||||
|
||||
- `ArialPixel.ttf` - Main font.
|
||||
- `package.json` - Here you can find all installed packages as well as scripts for creating prefixed and minified versions of cs16.css.
|
||||
- `index.html`, `index.css`, `main.js` - Files for documentation page.
|
||||
- `src/cs16.css` - Main cs16.css file. Edit this file if you want to change styling.
|
||||
- `css/cs16.css`, `css/cs16.min.css` - Do not touch these files. These files are generated by `build:css` script from package.json.
|
||||
|
||||
### Development
|
||||
|
||||
#### Fork this repo
|
||||
|
||||
You can fork this repo by clicking the fork button in the top right corner of the repo page.
|
||||
|
||||
#### Clone on your machine
|
||||
|
||||
```bash
|
||||
git clone https://github.com/your-username/cs16.css.git
|
||||
```
|
||||
|
||||
#### Create a new branch
|
||||
|
||||
```bash
|
||||
git checkout -b my-new-branch
|
||||
```
|
||||
|
||||
#### Install dependencies
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### Build css/cs16.css and css/cs16.min.css
|
||||
|
||||
```bash
|
||||
pnpm run build:css
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Loading…
Reference in a new issue