summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6230dd7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# Getting Started
+
+## Serving the site locally for development work
+
+In the root directory of the repository:
+
+```sh
+$ cobalt serve
+```
+
+## Building the site for produciton
+
+In the root directory of the repository:
+
+```sh
+$ cobalt build
+```
+
+## Updating pages and posts
+
+There is a git-hook on the origin server that rebuilds and publishes the site
+every time a push is made to the master branch. Site contributors need only make
+changes to the text of the pages and posts, publish them with `cobalt`, commit
+them, and then push them to master to see them go live.
+
+Below is a step-by-step guide
+
+### Adding a new post or page
+
+Enter the folder where you want new content to go. Tell `cobalt` to template a
+new post for you. Don't forget to provide a name for the post! You can verify
+the contents if you wish.
+
+```sh
+$ cd posts
+$ cobalt new "A New Tutoring Business"
+[info] Created new posts "posts/a-new-tutoring-business.md"
+$ cat a-new-tutoring-business.md
+---
+title: A New Tutoring Business
+categories:
+ - blog
+layout: post.liquid
+is_draft: true
+---
+(Post text goes here)
+```