Add tiny how-to-build-locally document

Bastardkb · Oct 17, 2023 · a59b88e · a59b88e
1 parent 3ef865d
commit a59b88e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/_config.yml b/_config.yml
@@ -11,6 +11,7 @@ exclude:
   - Gemfile
   - Gemfile.lock
   - _site/
+  - building-locally.md
 
 plugins:
   - jekyll-default-layout

diff --git a/building-locally.md b/building-locally.md
@@ -0,0 +1,7 @@
+#Building locally
+
+To build locally to preview changes, instally ruby and ruby-bundler, change directory into the cloned repository, and ```bundle install``` to fetch all necessary parts.
+
+Then, ```bundle exec jekyll serve``` to start a local web server, which will note the URL you should point your browser at in its output.
+To enable live previewing as you make changes (just need to reload your browser), add `--incremental`.
+