Skip to content

Commit

Permalink
Add a getting started guide to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kytrinyx committed Jun 23, 2012
1 parent 564173b commit ef21b3d
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
@@ -1,3 +1,54 @@
# We Are All Awesome

A blog with the intention of motivating, encouraging, and helping women and other minorities to begin speaking at conferences.

The site contains/will contain links to great talks, advice on generating getting ideas and writing proposals, conferences with open CFPs, etc.

## Contribute

1. Fork the repository
2. `gem install jekyll`
3. Make your changes
4. Submit a pull request

### Text format

If you're not familiar with markdown, check out [Daring Fireball's syntax guide](http://daringfireball.net/projects/markdown/syntax).


### Adding a blog post

Posts go in the `_posts` directory, and should be named `YYYY-MM-DD-the-title-of-the-post.md`

Start it off with the following:

---
layout: main
title: The Title of the Post
---

# {{ page.title }}

(where you'd swap out `The Title of the Post` with the actual title, obviously).

Then add whatever content you want below this.

### Eyeballing Your Changes

In the root of the project, run `jekyll` to generate the html files.
Then go to the `_site` directory and run the server.

cd _site
jekyll --server

When you run `jekyll --server` you'll probably see webrick start up. Look for the port number.

[2012-06-23 14:02:42] INFO WEBrick::HTTPServer#start: pid=3642 port=4000

Here it started on port 4000. That means that I can go see the actual site at (localhost:4000)[http://localhost:4000/]

## If you're still confused, ask Uncle Google

Actual conversation (with typos corrected) from #stationx on freenode about how I need to write a README Actual conversation (with typos corrected) from #stationx on freenode about how I need to write a README


``` ```
Expand Down

0 comments on commit ef21b3d

Please sign in to comment.