README.md 2.96 KB
Newer Older
Thomas Park's avatar
Thomas Park committed
1
2
3
Bootswatch
==========

Thomas Park's avatar
Thomas Park committed
4
5
6
[![Bootswatch Logo](./assets/img/logo-dark.png)](http://bootswatch.com)

Bootswatch is a collection of open source themes for [Bootstrap](http://getbootstrap.com/). Check it out at [bootswatch.com](http://bootswatch.com).
Thomas Park's avatar
Thomas Park committed
7
8
9

Usage
-----
10
Download the `bootstrap.min.css` file associated with a theme and replace Bootstrap's default stylesheet. You must still include Bootstrap's JavaScript file to have functional dropdowns, modals, etc.
Thomas Park's avatar
Thomas Park committed
11

12
The themes are also hosted on [BootstrapCDN](http://www.bootstrapcdn.com/bootswatch/). 
Thomas Park's avatar
Thomas Park committed
13

14
You can import a theme into your styles using either LESS or SASS.
15

16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
LESS:

```
@import "bootstrap/less/bootstrap.less";
@import "bootswatch/theme/variables.less";
@import "bootswatch/theme/bootswatch.less";

```

SASS:

```
@import "bootswatch/theme/variables";
@import "bootstrap-sass-official/assets/stylesheets/bootstrap";
@import "bootswatch/theme/bootswatch";

```
Thomas Park's avatar
Thomas Park committed
33
34
35
36


Customization
------
Thomas Park's avatar
Thomas Park committed
37
Bootswatch is open source and you’re welcome to modify the themes.
Thomas Park's avatar
Thomas Park committed
38

Thomas Park's avatar
Thomas Park committed
39
Each theme consists of two LESS files. `variables.less`, which is included by default in Bootstrap, allows you to customize [these settings](http://getbootstrap.com/customize/#less-variables). `bootswatch.less` introduces more extensive structural changes.
Thomas Park's avatar
Thomas Park committed
40

Thomas Park's avatar
Thomas Park committed
41
42
These files are also available in SASS.

Thomas Park's avatar
Thomas Park committed
43
Check out the [Help page](http://bootswatch.com/help/) for more details on building your own theme.
Thomas Park's avatar
Thomas Park committed
44
45
46
47

API
-----

48
A simple API is available for integrating your platform with Bootswatch. More info at http://bootswatch.com/help/#api
Thomas Park's avatar
Thomas Park committed
49

50
51
52
53
Contributing
-----
It's through your contributions that Bootswatch will continue to improve. You can contribute in several ways.

Thomas Park's avatar
Thomas Park committed
54
**Issues:** Provide a detailed report of any bugs you encounter and open an issue on [GitHub](https://github.com/thomaspark/bootswatch/issues).
55

Thomas Park's avatar
Thomas Park committed
56
**Documentation:** If you'd like to fix a typo or beef up the docs, you can fork the project, make your changes, and submit a pull request.
57

Thomas Park's avatar
Thomas Park committed
58
**Code:** Make a fix and submit it as a pull request. When making changes, it's important to keep the CSS, LESS and SASS versions in sync. To do this, be sure to edit the LESS source files for the particular theme, then run the  tasks `grunt swatch` and `grunt:convert_less` to build the CSS and LESS.
Thomas Park's avatar
Thomas Park committed
59
60

**Donation:** Donations are gratefully accepted via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=F22JEM3Q78JC2) and [Gratipay](https://gratipay.com/bootswatch/).
61

Thomas Park's avatar
Thomas Park committed
62
63
Author
------
Thomas Park's avatar
Thomas Park committed
64
Thomas Park
Thomas Park's avatar
Thomas Park committed
65

Thomas Park's avatar
Thomas Park committed
66
+ http://github.com/thomaspark
Thomas Park's avatar
Thomas Park committed
67
+ http://thomaspark.co
Thomas Park's avatar
Thomas Park committed
68
69
70

Thanks
------
71
[Mark Otto](https://github.com/mdo) and [Jacob Thornton](https://github.com/fat) for [Bootstrap](https://github.com/twbs/bootstrap).
Thomas Park's avatar
Thomas Park committed
72

Thomas Park's avatar
Thomas Park committed
73
[Jenil Gogari](http://www.jgog.in/) for his contributions to the Flatly theme.
Thomas Park's avatar
Thomas Park committed
74

Thomas Park's avatar
Thomas Park committed
75
76
77
[James Taylor](https://github.com/jostylr) for [cors-lite](https://github.com/jostylr/cors-lite).

[Corey Sewell](https://github.com/cjsewell) for SASS conversion.
Thomas Park's avatar
Thomas Park committed
78
79
80
81


Copyright and License
----
Thomas Park's avatar
Thomas Park committed
82
Copyright 2014 Thomas Park
Thomas Park's avatar
Thomas Park committed
83

84
Code released under the MIT License.