aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: b5fa86c73a82f39017d08656a7f2c895315dfcc4 (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
# cs16.css

## Introduction

cs16.css is a css library based on Counter Strike 1.6 UI.

## Installation

You can install cs16.css simply by pasting this to your html `head` tag:

```html
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/ekmas/cs16.css@main/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
pnpm install
```

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

```bash
pnpm run build:css
```

## License

MIT