-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README with minimal build instructions
Closes #4
- Loading branch information
1 parent
ebfa42b
commit 428c2ff
Showing
2 changed files
with
23 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters