Skip to content

Commit 8c8e1a9

Browse files
author
mrmrs
committed
Adds directions to readme.
1 parent 219651a commit 8c8e1a9

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
Checkout [ht-ml.cc](http://ht-ml.cc "HTML - Common patterns for reuse")
22

3-
# HTML - Work in Progress
3+
# HTML
44

5-
#### Common Markup Patterns
6-
7-
Common markup patterns useful for developing prototypes or creating new themes.
5+
Common markup patterns I use for developing websites.
86

97
# Features
108

9+
* All non-media elements in the HTML5 spec are included on one page and are ready to be styled.
1110
* Modular Structure - add your own patterns, or delete the ones you don't like.
12-
* Semantic markup examples for common design patterns.
11+
* Semantic and accessible markup examples for common design patterns.
1312
* 100% responsive except for the silly img element :)
14-
* Thoroughly commented code (Useful comments and reference links for new HTML developers)
13+
* Thoroughly commented code (notes and reference links for new HTML developers)
1514

16-
# Getting started
15+
# Getting the Code
1716

1817
* Create a new repo for your project on Github
1918
* In terminal run
@@ -31,12 +30,25 @@ Common markup patterns useful for developing prototypes or creating new themes.
3130
origin git@github.com:yourUserName/yourNewRepoName.git (push)
3231
```
3332

34-
* Once you add & commit files you are ready to publish run:
35-
```bash
36-
git push -u origin master
33+
Now your set up to use this in a new project.
34+
35+
# Getting Started
36+
37+
## The HTML
38+
* Open up index.html with your favorite text editor and hack away. It's that simple.
39+
* To preview changes at http://localhost:8000 - open up terminal.app and type
40+
```
41+
python -m SimpleHTTPServer
3742
```
3843

39-
Now your set up to use this in a new project.
44+
## The CSS
45+
46+
If you use sass you can run ```rake sass``` from the root of the directory and then
47+
edit ```_sass/_styles.scss``` to style the content in index.html
48+
49+
If you'd like to just edit the vanilla css you can delete the _sass directory and
50+
just edit ```css/i.css```
51+
4052

4153
# Author
4254
[MRMRS](http://mrmrs.cc "Adam Morse - Designer Developer")

0 commit comments

Comments
 (0)