opdavies/sculpin-skeleton
Template
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add README

Browse source
This commit is contained in:
Oliver Davies 2017-09-11 22:29:35 +01:00
parent 9fe8c4dda6
commit 1c23d4afda
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md Normal file
View file

@ -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