Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.42 KB

README.md

File metadata and controls

41 lines (30 loc) · 1.42 KB

Sun Research Group Handbook

This is the official repository for the Sun Group Handbook hosted at https://nrdavid.github.io/whsun-docs/.

This branch uses MKdocs and MKdocs-Material.

The site is maintained by the Sun Research Group at the University of Michigan in Ann Arbor, MI, USA.

Installation

  1. Verify conda is installed. Otherwise, you can find the installation here.

    conda --version

  2. Clone the repository.

    git clone [email protected]:nrdavid/whsun-docs.git
cd whsun-docs

  3. Create the environment from the `environment.yml' file.

    conda env create -f environment.yml
conda activate whsun-docs

  4. Run the development server.

    mkdocs serve

Contributing

First off, thank you so much for contributing to our group's handbook. These contributions will help current and future group members excel in their research.

  1. Please create a branch to add/commit changes to followed with a pull request. Rebase your branch to the "main" branch before submitting your pull request.
  2. A reviewer will either accept or reject your request.