Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.35 KB

README.md

File metadata and controls

63 lines (43 loc) · 1.35 KB
Raw

Releases

See all releases and the status of repos at releases.elementary.io

Building

You'll need the following dependencies:

ruby-full
build-essential
zlib1g-dev

We recommend installing gems to a (hidden) directory in your home folder:

echo '' >> ~/.bashrc
echo '# Install Ruby Gems to ~/.gems' >> ~/.bashrc
echo 'export GEM_HOME="$HOME/.gems"' >> ~/.bashrc
echo 'export PATH="$HOME/.gems/bin:$PATH"' >> ~/.bashrc
echo '' >> ~/.bashrc
source ~/.bashrc

Install bundler:

gem install bundler

Install gems:

bundle install

Build and serve locally with:

bundle exec jekyll serve --host 0.0.0.0

The site should now be available at http://0.0.0.0:4000/ on your local machine, and your local machine's IP address on your network—great for testing on mobile OSes.

Updating Data

_data/repos.json is automatically rebuilt from a GitHub Action, but you can build it for local development:

First, create a GitHub token with repo permissions and copy it somewhere safe.

Then, make sure you have pip and PyGithub. On elementary OS:

sudo apt install python3-pip
pip install PyGithub

Lastly, run release.py re-using your token as an environment variable, e.g.:

GITHUB_TOKEN=ghp_aBcDeFgHiJkLmNoPqRsTuVwXyZ python3 release.py