@@ -1,82 +1 @@
1-# Poole
2-
3-In the novel, *The Strange Case of Dr. Jeykll and Mr. Hyde*, Mr. Poole is Dr. Jekyll's virtuous and loyal butler. Similarly, Poole serves as an upstanding and effective foundation for Jekyll themes by [@mdo](https://twitter.com/mdo).
4-
5-There are currently two themes built on Poole:
6-
7-* [Hyde](http://hyde.getpoole.com)
8-* [Lanyon](http://lanyon.getpoole.com)
9-
10-
11-## Usage
12-
13-### 1. Install Jekyll
14-
15-Poole is built for use with Jekyll, so naturally you'll need to install that. On Macs, it's rather straightforward:
16-
17-```bash
18-$ gem install jekyll
19-```
20-
21-**Windows users:** Windows users have a bit more work to do, but luckily [@juthilo](https://github.com/juthilo) has your back with his [Run Jekyll on Windows](https://github.com/juthilo/run-jekyll-on-windows) guide.
22-
23-You may also need to install Pygments, the Python syntax highlighter for code snippets that plays nicely with Jekyll. Read more about this [in the Jekyll docs](http://jekyllrb.com/docs/templates/#code_snippet_highlighting).
24-
25-### 2a. Quick start
26-
27-To help anyone with any level of familiarity with Jekyll quickly get started, Poole includes everything you need for a basic Jekyll site. To that end, just download Poole and start up Jekyll.
28-
29-### 2b. Roll your own Jekyll site
30-
31-Folks wishing to use Jekyll's templates and styles can do so with a little bit of manual labor. Download Poole and then copy what you need (likely `_layouts/`, `*.html` files, `atom.xml` for RSS, and `public/` for CSS, JS, etc.).
32-
33-### 3. Running locally
34-
35-To see your Jekyll site with Poole applied, start a Jekyll server. In Terminal, from `/Poole` (or whatever your Jekyll site's root directory is named):
36-
37-```bash
38-$ jekyll serve
39-```
40-
41-Open <http://localhost:4000> in your browser, and voilà. You're done.
42-
43-
44-## Options
45-
46-Poole includes some customizable options, typically applied via classes on the `<body>` element.
47-
48-
49-### Rems, `font-size`, and scaling
50-
51-Poole is built almost entirely with `rem`s (instead of pixels like Hyde 1.1.x). `rem`s are like `em`s, but instead of building on the immediate parent's `font-size`, they build on the root element, `<html>`.
52-
53-By default, we use the following:
54-
55-```css
56-html {
57- font-size: 16px;
58- line-height: 1.5;
59-}
60-@media (min-width: 48rem) { /* ~768px */
61- html {
62- font-size: 20px;
63- }
64-}
65-
66-```
67-
68-To easily scale your site's typography and components, simply customize the base `font-size`s here.
69-
70-
71-## Author
72-
73-**Mark Otto**
74-<https://github.com/mdo>
75-<https://twitter.com/mdo>
76-
77-
78-## License
79-
80-Open sourced under the [MIT license](LICENSE.md).
81-
82-<3
1+Soon.