Skip to content

Commit c8af19b

Browse files
committed
update README
1 parent 7acd5cc commit c8af19b

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
# 2025-sourmash-databases-doc-template
22

3+
This repo uses Jinja2 templating to automatically produce Markdown
4+
files describing the available sourmash databases. It also produces
5+
automated scripts that check that the relevant files are available for
6+
download.
7+
8+
## Basic instructions
9+
310
Run `make`. Then look at [outputs/md](outputs/md) to see output markdown.
411

512
## Previewing formatting with mkdocs
613

714
Run `mkdocs serve` to see the generated files.
815

9-
## Updating sourmash database list
16+
## Updating the database list in the sourmash docs
1017

1118
Copy all the files in `outputs/md/` into the sourmash repo under `doc/databases-md/`.
1219

0 commit comments

Comments
 (0)