Skip to content

Commit 942a70d

Browse files
authored
Add local install instructions
1 parent f760568 commit 942a70d

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ I think I've got things running smoothly and fixed some major bugs, but feel fre
1414

1515
See more info at https://academicpages.github.io/
1616

17+
## To run locally (not on GitHub Pages, to serve on your own computer)
18+
1. Clone the repository and made updates as detailed above
19+
1. Make sure you have ruby-dev, bundler, and nodejs installed: `sudo apt install ruby-dev ruby-bundler nodejs`
20+
1. Run `bundle clean` to clean up the directory (no need to run `--force`)
21+
1. Run `bundle install` to install ruby dependencies
22+
1. Run `bundle exec jekyll serve` to generate the HTML and serve it from localhost:4000
23+
1724
# Changelog -- bugfixes and enhancements
1825

1926
There is one logistical issue with a ready-to-fork template theme like academic pages that makes it a little tricky to get bug fixes and updates to the core theme. If you fork this repository, customize it, then pull again, you'll probably get merge conflicts. If you want to save your various .yml configuration files and markdown files, you can delete the repository and fork it again. Or you can manually patch.

0 commit comments

Comments
 (0)