Skip to content

Commit cd56a5b

Browse files
committed
Start updating the README
1 parent 46ffad6 commit cd56a5b

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
A Github Pages template for academic websites. This was forked (then detached) by [Stuart Geiger](https://github.com/staeiou) from the [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/), which is © 2016 Michael Rose and released under the MIT License. See LICENSE.md.
21

3-
I think I've got things running smoothly and fixed some major bugs, but feel free to file issues or make pull requests if you want to improve the generic template / theme.
2+
# Academic Pages
3+
4+
![pages-build-deployment](https://github.com/academicpages/academicpages.github.io/actions/workflows/pages/pages-build-deployment/badge.svg)
45

5-
### Note: if you are using this repo and now get a notification about a security vulnerability, delete the Gemfile.lock file.
6+
Academic Pages is a Github Pages template for academic websites. This was forked (then detached) by [Stuart Geiger](https://github.com/staeiou) from the [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/), which is © 2016 Michael Rose and released under the MIT License. See LICENSE.md.
7+
8+
I think I've got things running smoothly and fixed some major bugs, but feel free to file issues or make pull requests if you want to improve the generic template / theme.
69

710
# Instructions
811

@@ -20,9 +23,8 @@ See more info at https://academicpages.github.io/
2023

2124
1. Clone the repository and made updates as detailed above
2225
1. Make sure you have ruby-dev, bundler, and nodejs installed: `sudo apt install ruby-dev ruby-bundler nodejs`
23-
1. Run `bundle clean` to clean up the directory (no need to run `--force`)
2426
1. Run `bundle install` to install ruby dependencies. If you get errors, delete Gemfile.lock and try again.
25-
1. Run `bundle exec jekyll liveserve` to generate the HTML and serve it from `localhost:4000` the local server will automatically rebuild and refresh the pages on change.
27+
1. Run `jekyll serve -l` to generate the HTML and serve it from `localhost:4000` the local server will automatically rebuild and refresh the pages on change.
2628

2729
# Changelog -- bugfixes and enhancements
2830

0 commit comments

Comments
 (0)