diff options
| -rw-r--r-- | README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..75bb8fc --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +This is the code for generating my website (prefetch.eu) using Jekyll. + +To try it out, make sure you have `ruby`, `gem` and `bundler` installed. +I prefer to download the former two from my distro's package manager, +and then to use `gem` to install `bundler`; e.g. on Arch Linux run: + +```sh +$ sudo pacman -S ruby rubygems +$ gem install bundler +``` + +Then in this directory, run the following commands to get Jekyll and +all its extensions needed by this website as listed in the `Gemfile`: + +```sh +$ bundle config set --local path .bundle +$ bundle install +``` + +Now you should be able to run a local development version with: + +```sh +$ make serve +``` + +To build and deploy the release version, install `rsync` and run: + +```sh +$ make build +$ make compress +$ make deploy HOST=user@example.com PORT=22 +``` |