Skip to content

Commit

Permalink
Add README with minimal build instructions
Browse files Browse the repository at this point in the history
Closes #4
  • Loading branch information
poikilotherm committed Sep 29, 2022
1 parent ebfa42b commit 428c2ff
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# HElmholtz Rich MEtadata Software publication (HERMES)

This code repository contains the [Sphinx](https://sphinx-docs.org), [MyST](https://) and [sphinx-book-theme]() based website for the HERMES project.

Please visit https://project.software-metadata.pub for further reading.

## Build locally

To use the convenient `Makefile`, you need to have `make` installed.
[You might want to use a virtual Python environment.](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/)

```shell

pip install -r requirements.txt
make html

- OR -

pip install -r requirements.txt
make livehtml

```
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'venv', '.venv']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'venv', '.venv', 'README.md']

# Prefix document path to section labels, to use:
# `path/to/file:heading` instead of just `heading`
Expand Down

0 comments on commit 428c2ff

Please sign in to comment.