Merge pull request #37 from dirkolbrich/gemfile

chennes · web-flow · commit f02cfdd1c27d · 2023-04-17T08:18:52.000-05:00
add Gemfile for local build
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,11 @@
-_site
-.sass-cache
-.jekyll-cache
+Gemfile.lock
+
+# Ignore metadata generated by Jekyll
+_site/
+.sass-cache/
+.jekyll-cache/
 .jekyll-metadata
-vendor
+
+# Ignore folders generated by Bundler
+.bundle/
+vendor/
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'github-pages', group: :jekyll_plugins
+gem "webrick", "~> 1.8"
diff --git a/Gemfile.lock b/Gemfile.lock
diff --git a/README.md b/README.md
@@ -2,3 +2,13 @@
 
 This is the repo for the [Developers Handbook](https://freecad.github.io/DevelopersHandbook/)
 
+## Install an run locally
+
+Make sure the dependencies `Ruby`, `Jekyll` and `Bundler` are installed on your system. See the [Jekyll installation guidelines](https://jekyllrb.com/docs/installation/) as well as the [Ruby 101 notes](https://jekyllrb.com/docs/ruby-101/) on how to setup your system.
+
+Clone this repo locally, run the `Bundler` installation and serve the site at `http://127.0.0.1:4000`:
+
+```bash
+bundle install
+bundle exec jekyll serve
+```

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+source 'https://rubygems.org'`
	`2`	`+gem 'github-pages', group: :jekyll_plugins`
	`3`	`+gem "webrick", "~> 1.8"`