Summary Files Commits Branches @commit @diff @stats
path: root / README.md
blob: eaf92969809026ed1fd5b72bde2d9dee1d5965b6 (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
<a href="https://kingajax.github.io/Spectre-Dark">
  <img src="https://kingajax.github.io/Spectre-Dark/img/spectre-logo.svg" width="72" height="72">
</a>

## Spectre.css

Spectre.css is a lightweight, responsive and modern CSS framework. Check out the [upstream repo](https://github.com/picturepan2/spectre) and the [dark-mode upstream](https://github.com/kingajax/Spectre-Dark).

This fork modifies (poorly) the colors to match my preferences for a gruvbox-y style. Most of the colours are made to feel like those on [my website](https://syndamia.com). Use at your own visual risk!

## Getting started

The **best** way to get this version of Spectre is to compile it. 

Although, if you only need `spectre.min.css`, you can directly use the one on my website (beware: no warranty about anything):

```
<link rel="stylesheet" href="https://syndamia.com/spectre.min.css">
```

## Compiling

### Requirements

- `node`, install instructions [here](https://nodejs.org/en/download/)
- `gulp`, you can install it as a global tool with `sudo npm install gulp -g`

**Warning:** currently there is an issue with new node versions, if `gulp build` gives you an error, follow these steps:

1. Install "n": `sudo npm install -g n`

2. Downgrade node to version 11 (11.15.0): `sudo n 11`

3. Rebuld sass for the new node version: `npm rebuild node-sass`

### How to build

1. Clone the repository

2. Navigate to the folder of the repository

3. Run `npm install`

4. Run `gulp build`

5. You're done, the compiled CSS files are in the `dist` folder

For more information, refer to [kingajax's documentation](https://kingajax.github.io/Spectre-Dark/getting-started/custom.html).

## Browser support

Spectre uses [Autoprefixer](https://github.com/postcss/autoprefixer) to make most styles compatible with earlier browsers and [Normalize.css](https://necolas.github.io/normalize.css/) for CSS resets. Spectre is designed for modern browsers. For best compatibility, these browsers are recommended:

- Chrome (LAST 4)
- Microsoft Edge (LAST 4)
- Firefox (EXTENDED SUPPORT RELEASE)
- Safari (LAST 4)
- Opera (LAST 4)
- Internet Explorer 10+

Spectre supports Internet Explorer 10+, but some HTML5 and CSS3 features are not perfectly supported by Internet Explorer.

Designed and built with ♥ by [Yan Zhu](https://twitter.com/picturepan2) and modified by [kingajax](https://github.com/kingajax/Spectre-Dark).