Skip to content

Commit

Permalink
Update installation instructions and repository names
Browse files Browse the repository at this point in the history
* Add missing dependency
* Add ruby version number
* Update installation instructions
  • Loading branch information
DaniilPaskal authored Sep 18, 2024
1 parent 220c01b commit eddcd95
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 12 deletions.
2 changes: 2 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ gem "jekyll-github-metadata"
gem "minitest"
gem "html-proofer"
gem 'github-pages', group: :jekyll_plugins

gem "webrick", "~> 1.8"
4 changes: 3 additions & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,9 @@ GEM
thread_safe (~> 0.1)
unf (0.1.4)
unf_ext
unf_ext (0.0.8.2)
unf_ext (0.0.9.1)
unicode-display_width (1.8.0)
webrick (1.8.1)
yell (2.2.2)
zeitwerk (2.6.0)

Expand All @@ -274,6 +275,7 @@ DEPENDENCIES
jekyll
jekyll-github-metadata
minitest
webrick (~> 1.8)

BUNDLED WITH
2.2.5
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Waterloo Region Votes

This repository is published to
https://civictechwr.github.io/WRVotesMunicipal2022
https://civictechwr.github.io/WRVotesFed2025

It is updated for the 2022 municipal election in Waterloo Region.

Expand All @@ -13,15 +13,16 @@ Dependencies:
- Jekyll

To get started locally:
- Clone the repo: `git clone https://github.com/CivicTechWR/WRVotesMunicipal2022.git`
- Clone the repo: `git clone https://github.com/CivicTechWR/WRVotesFed2025.git`
- Navigate to the project folder: `cd WRVotesFed2025`
- Install gems: `bundle`
- Move into the website directory: `cd docs`
- Start the local server: `jekyll serve`

### Getting started on OSX

1. Install [homebrew](https://brew.sh/) package manager
2. Install ruby:
2. Install ruby (version 3.1):
```
brew install ruby
```
Expand All @@ -31,11 +32,11 @@ To get started locally:
```
4. Clone the repo:
```
git clone https://github.com/CivicTechWR/WRVotesMunicipal2022.git
git clone https://github.com/CivicTechWR/WRVotesFed2025.git
```
5. Then go into the WRVotesMunicipal2022 directory, and run install the gems:
5. Then go into the WRVotesFed2025 directory, and run install the gems:
```
cd WRVotesMunicipal2022
cd WRVotesFed2025
bundle install
```
6. Then start the jekyll server:
Expand All @@ -49,8 +50,4 @@ To get started locally:
## How can I help?
See the
[Issues
list](https://github.com/CivicTechWR/WRVotesMunicipal2022/issues).

This project began as an initiative of
[CivicTechWR](https://civictechwr.org) but as of this writing (Aug
2022) that group is dormant.
list](https://github.com/CivicTechWR/WRVotesFed2025/issues).

0 comments on commit eddcd95

Please sign in to comment.