Skip to content

Commit

Permalink
change theme
Browse files Browse the repository at this point in the history
  • Loading branch information
erexer committed May 17, 2024
1 parent 82b47dd commit 5bb8cf0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@
],
"logo_target": "https://im3.pnnl.gov/",
}
html_logo = "_static/im3logo.png"
html_logo = "im3logo.png"
html_static_path = ['_static']
6 changes: 4 additions & 2 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# metarepo
`metarepo` is short for meta-repository, a GitHub repository that contains instructions to reproduce results in a published work. This repo is a template for creating your own metarepo.

[![Use the `metarepo` template|32x32](https://github.com/new?template_name=metarepo&template_owner=IMMM-SFA)]
[![Use the metarepo template|32x32](https://github.com/new?template_name=metarepo&template_owner=IMMM-SFA)]

## Purpose
A meta-repository creates a single point of access for someone to find all of the components that were used to create a published work for the purpose of reproducibility. This repository should contain references to all minted data and software as well as any ancillary code used to transform the source data, create figures for your publication, conduct the experiment, and / or execute the contributing software.
Expand All @@ -27,7 +27,9 @@ D. [Add a DOI to your metarepo](#d-add-a-doi-to-your-metarepo)
E. [Add your metarepo citation to your paper](#e-add-your-metarepo-citation-to-your-paper)

### A. Use the template to initialize your own meta-repo
Click `Use this template` on the [main repository page](https://github.com/IMMM-SFA/metarepo/) (shows up above `Clone or download`) and click `Create a new repository`. Fill in your `Repository name` (naming conventions below), the `Description`, select whether you want the repository to be `Public` or `Private`, and leave `Include all branches` unchecked. Click `Create repository`. You'll be taken to the new repository you created.
Either click on the `Use the metarepo template` link at the top of this page, or click `Use this template` on the [main repository page](https://github.com/IMMM-SFA/metarepo/) (shows up above `Clone or download`) and click `Create a new repository`.

Fill in your `Repository name` (naming conventions below), the `Description`, select whether you want the repository to be `Public` or `Private`, and leave `Include all branches` unchecked. Click `Create repository`. You'll be taken to the new repository you created.

Note: The following naming conventions should be used when naming your repository:
- Single author: `lastname_year_journal`
Expand Down

0 comments on commit 5bb8cf0

Please sign in to comment.