From 1c23d4afdafba80e2e57b39657dae3f677b78622 Mon Sep 17 00:00:00 2001 From: Oliver Davies Date: Mon, 11 Sep 2017 22:29:35 +0100 Subject: [PATCH] Add README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..03a78ae --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Sculpin Skeleton + +A skeleton project for the [Sculpin][1] static site generator. + +## Usage + +1. Download the project by running `composer create-project opdavies/sculpin-skeleton --stability dev my-sculpin-site`. +1. Run `vendor/bin/sculpin generate --server --watch` to generate and serve the site. +1. Start adding content to `source/index.md`. + +## Notes + +- The `posts` content type is disabled by default. Re-enable it if needed by removing `enabled: false` from `app/config/sculpin_kernel.yml`. + +[1]: https://sculpin.io