From 11dac5a2722d1f3c3444a65ccdb890d8647a6e72 Mon Sep 17 00:00:00 2001 From: Jacob Thompson Date: Mon, 30 Dec 2024 14:59:06 -0800 Subject: [PATCH] update README --- README.md | 74 ++++++++++++++++++------------------------------------- 1 file changed, 24 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index ba7077d..65ffb6b 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,31 @@ -# Academic Pages -**Academic Pages is a Github Pages template for academic websites.** +# jacob-thompson.github.io -# Getting Started +Source code for my personal website, hosted at [jacob-thompson.github.io](https://jacob-thompson.github.io). -1. Register a GitHub account if you don't have one and confirm your e-mail (required!) -1. Click the "Use this template" button in the top right. -1. On the "New repository" page, enter your repository name as "[your GitHub username].github.io", which will also be your website's URL. -1. Set site-wide configuration and add your content. -1. Upload any files (like PDFs, .zip files, etc.) to the `files/` directory. They will appear at https://[your GitHub username].github.io/files/example.pdf. -1. Check status by going to the repository settings, in the "GitHub pages" section -1. (Optional) Use the Jupyter notebooks or python scripts in the `markdown_generator` folder to generate markdown files for publications and talks from a TSV file. +## Running Locally -See more info at https://academicpages.github.io/ +### Install Dependencies -## Running locally +Linux: +```bash +sudo apt install ruby-dev ruby-bundler nodejs +``` -When you are initially working your website, it is very useful to be able to preview the changes locally before pushing them to GitHub. To work locally you will need to: +MacOS: +```bash +brew install ruby +brew install node +gem install bundler +``` -1. Clone the repository and made updates as detailed above. -1. Make sure you have ruby-dev, bundler, and nodejs installed - - On most Linux distribution and [Windows Subsystem Linux](https://learn.microsoft.com/en-us/windows/wsl/about) the command is: - ```bash - sudo apt install ruby-dev ruby-bundler nodejs - ``` - On MacOS the commands are: - ```bash - brew install ruby - brew install node - gem install bundler - ``` -1. Run `bundle install` to install ruby dependencies. If you get errors, delete Gemfile.lock and try again. -1. Run `jekyll serve -l -H localhost` to generate the HTML and serve it from `localhost:4000` the local server will automatically rebuild and refresh the pages on change. +### Run -If you are running on Linux it may be necessary to install some additional dependencies prior to being able to run locally: `sudo apt install build-essential gcc make` +```bash +bundle install +jekyll serve -l -H localhost +``` -## Using Docker +### Docker Working from a different OS, or just want to avoid installing dependencies? You can use the provided `Dockerfile` to build a container that will run the site for you if you have [Docker](https://www.docker.com/) installed. @@ -50,26 +40,10 @@ Next, run the container: docker run -p 4000:4000 --rm -v $(pwd):/usr/src/app jekyll-site ``` -# Maintenance +## Academic Pages -Bug reports and feature requests to the template should be [submitted via GitHub](https://github.com/academicpages/academicpages.github.io/issues/new/choose). For questions concerning how to style the template, please feel free to start a [new discussion on GitHub](https://github.com/academicpages/academicpages.github.io/discussions). - -This repository 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). It is currently being maintained by [Robert Zupko](https://github.com/rjzupkoii) and additional maintainers would be welcomed. - -## Bugfixes and enhancements +[Academic Pages](https://academicpages.github.io/) // [Academic Pages source code](https://github.com/academicpages/academicpages.github.io) -If you have bugfixes and enhancements that you would like to submit as a pull request, you will need to [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this repository as opposed to using it as a template. This will also allow you to [synchronize your copy](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) of template to your fork as well. - -Unfortunately, one logistical issue with a template theme like Academic Pages that makes it a little tricky to get bug fixes and updates to the core theme. If you use this template and customize it, you will probably get merge conflicts if you attempt to synchronize. 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. - ---- -
- -![pages-build-deployment](https://github.com/academicpages/academicpages.github.io/actions/workflows/pages/pages-build-deployment/badge.svg) -[![GitHub contributors](https://img.shields.io/github/contributors/academicpages/academicpages.github.io.svg)](https://github.com/academicpages/academicpages.github.io/graphs/contributors) -[![GitHub release](https://img.shields.io/github/v/release/academicpages/academicpages.github.io)](https://github.com/academicpages/academicpages.github.io/releases/latest) -[![GitHub license](https://img.shields.io/github/license/academicpages/academicpages.github.io?color=blue)](https://github.com/academicpages/academicpages.github.io/blob/master/LICENSE) +Bug reports and feature requests to the template should be [submitted via GitHub](https://github.com/academicpages/academicpages.github.io/issues/new/choose). For questions concerning how to style the template, please feel free to start a [new discussion on GitHub](https://github.com/academicpages/academicpages.github.io/discussions). -[![GitHub stars](https://img.shields.io/github/stars/academicpages/academicpages.github.io)](https://github.com/academicpages/academicpages.github.io) -[![GitHub forks](https://img.shields.io/github/forks/academicpages/academicpages.github.io)](https://github.com/academicpages/academicpages.github.io/fork) -
\ No newline at end of file +The Academic Pages repository 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](/LICENSE)).