Skip to content

Commit

Permalink
Jekyll instructions and better README
Browse files Browse the repository at this point in the history
  • Loading branch information
cassiancc committed Feb 23, 2025
1 parent d54f581 commit d6eae7c
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 305 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ _site
.jekyll-cache
.jekyll-metadata
vendor
Gemfile.lock
289 changes: 0 additions & 289 deletions Gemfile.lock

This file was deleted.

19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
# norseiot.club
This repo is the official website of the Norse IoT Club. As a student-driven club, we believe in making it accessible for students to edit. Members of the club are encouraged to make changes to the site with the goal to improve our club's presence.

## Installing

norseiot.club is a Jekyll website hosted through GitHub Pages. To edit the site locally, you need [Jekyll](https://jekyllrb.com/docs/installation/) installed. With Jekyll installed, you can clone the site and edit it with a live preview.

```bash
git clone https://github.com/Norse-IoT/norse-iot.github.io.git
cd norse-iot.github.io
bundle install
```

For a live preview, run:
```bash
bundle exec jekyll serve
```

## Libraries
- Font Awesome 4, used under the SIL OFL 1.1 License https://fontawesome.com/v4/license/
- Bootstrap v5.1.3, used under the [MIT License](https://github.com/twbs/bootstrap/blob/main/LICENSE)
- Font Awesome 4, used under the [SIL OFL 1.1 License](https://fontawesome.com/v4/license/)
- Universal Smooth Scroll, used under the [MIT License](https://github.com/CristianDavideConte/universalSmoothScroll/blob/master/LICENSE)

## Credits
- Chris Brewer and Jonathan Makunga, for the initial site design.
Expand Down
1 change: 0 additions & 1 deletion js/0684e703d5.js

This file was deleted.

14 changes: 0 additions & 14 deletions js/1727692.js

This file was deleted.

0 comments on commit d6eae7c

Please sign in to comment.