Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.64 KB

README.md

File metadata and controls

51 lines (33 loc) · 1.64 KB
Raw

The Distort project

This is the repository backing the homepage of the distort project, at https://www.distortapp.org

You can use the editor on GitHub to maintain and preview the content for your website in Markdown files.

Whenever you commit to this repository, GitHub Pages will run Jekyll to rebuild the pages in your site, from the content in your Markdown files.

Building the page from your dev environment

  1. Once: install RVM

    based on https://rvm.io/rvm/install .

    gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB curl -sSL https://get.rvm.io | bash -s stable --ruby

  2. Once: install Ruby (> 2.1.0)

    source ~/.rvm/scripts/rvm

    this ruby version matches the one in .ruby-version

    rvm install ruby-2.4.5

    set as default (optional)

    rvm --default use 2.4.5

  3. Once: install additional ruby gems in your custom ruby install

    cd && rvm use gem install bundler bundle install # (installs stuff from ./Gemfile)

  4. Each time: When working on the site, use the same version of ruby with the project's Gemset

    source ~/.rvm/scripts/rvm cd && rvm use

  5. The rest, building, deploying, is jekyll specific See https://help.github.com/en/articles/setting-up-your-github-pages-site-locally-with-jekyll

    View local site: bundle exec jekyll serve

    (this makes the site available for you to browse at localhost:4000/, and will regenerate the site when files change)