aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: a750ea5b11a195ae42c2118d2cf122fc4003074c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
[![Preview Image](./public/preview.png)](https://git.estrogen.zone/cs16-defaults.css.git/about)

# cs16.css

## Introduction

CSS library based on [cs16.css](https://cs16.samke.me/), adapted to modify default styles of elements. Attempts to "just work" everywhere.

## Installation

You can install cs16.css simply by pasting this to your html `head` tag and adding `class="cs"` to your body (or wherever else you wish to enable "cs1.6 mode"):

```html
<link
  rel="stylesheet"
  type="text/css"
  href="https://git.estrogen.zone/cs16-defaults.css.git/plain/css/cs16.min.css"
/>
```

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
deno install
```

#### Build css/cs16.css and css/cs16.min.css

```bash
deno task build:css
```

## License

MIT