From bff180d166d043213dea9194b3adbba830bb0f7c Mon Sep 17 00:00:00 2001 From: Zach Leatherman Date: Tue, 16 Jan 2018 21:21:05 -0600 Subject: [PATCH] Instructions. --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 4bddb8f..3473fa4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,39 @@ # eleventy-base-blog A starter repository for eleventy static site generator projects. + +## Getting Started + +1. Clone this repository: + +``` +git clone https://github.com/11ty/eleventy-base-blog.git my-blog-name +``` + +2. Navigate to the directory + +``` +cd my-blog-name +``` + +3. Install dependencies + +``` +npm install +``` + +4. Run Eleventy + +``` +npx eleventy +``` + +Or build automatically when a template changes: +``` +npx eleventy --watch +``` + +Or in debug mode: +``` +DEBUG=* npx eleventy +``` \ No newline at end of file