Skip to content

Commit

Permalink
Add quickstart guide to README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
valderman authored Mar 16, 2017
1 parent 49144e7 commit 97830f7
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@ course websites.
To see CCFW in action, visit the [example website](http://ekblad.cc/ccwf).


Quickstart
----------

To quickly get started with CCWF:

1. Clone this repository: `git clone https://github.com/valderman/ccwf.git`
2. Add your course information to the `website.hs` build script.
3. Modify the example website by adding, removing and modifying markdown files
in the `pages` subdirectory.
4. Build your new course website: `runghc website.hs rebuild`
5. Commit your changes.
6. Whenever you need an official CCFW update, rebase your changes onto the
latest changes: `git fetch && git rebase`


Overview
--------

Expand Down

0 comments on commit 97830f7

Please sign in to comment.