From d754089b172e1ffcd0060ed4e8f9d616fe84149b Mon Sep 17 00:00:00 2001 From: Oliver Davies Date: Tue, 7 Sep 2021 21:34:50 +0100 Subject: [PATCH] docs: Updated README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index d78b11b..678593b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ # sculpin-talk-demo +A demonstration [Sculpin](https://sculpin.io) website, generated from my [Sculpin Skeleton](https://github.com/opdavies/sculpin-skeleton) project. + +## Running locally + +The easiest way to run the site locally is by using my [Sculpin Serve docker image](https://github.com/opdavies/docker-image-sculpin-serve): + docker run --rm -it \ -p 8000:8000 \ -v $(pwd):/app \ --name sculpin-demo \ opdavies/sculpin-serve + +This will install the Composer dependencies, generate and serve the site at http://localhost:8000, and automatically re-generate the site if any changes are made. + +## Links + +* To see the generated site, go to . +* For more information, and to see the slides and video for the talk, go to .