Skip to content

Commit b0ab86f

Browse files
committed
Update README
1 parent e27030d commit b0ab86f

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,20 @@
1-
## Welcome to the IMCF
1+
# Welcome to the IMCF GitHub Pages repo
22

3-
* The official [Imaging Core Facility (IMCF)](https://biozentrum.unibas.ch/imcf) website
3+
[![Deploy 🚚 IMCF 🔬 pages and API docs][gha_badge]][gha_workflow]
44

5-
## API documentation
5+
This repo contains:
66

7-
Documentation on the API for various of [our projects](https://github.com/imcf) can be
8-
found here:
7+
* 📝 Code to generate [API documentation for various IMCF packages][apidocs].
8+
* 🟪 Scripts to generate static HTML for [imcf.one][imcf_one] via [hugo][hugo].
9+
* 📦 Additional static content (images, ...) not produced through hugo.
10+
* 🚀 GitHub Actions to drive the above.
911

10-
* [IMCF API documentation](/apidocs)
12+
## TODO
13+
14+
* Provide instructions on adding static content.
15+
16+
[apidocs]: https://imcf.one/apidocs/
17+
[imcf_one]: https://imcf.one/
18+
[hugo]: https://gohugo.io/
19+
[gha_badge]:https://github.com/imcf/imcf.github.io/actions/workflows/deploy-pages.yml/badge.svg
20+
[gha_workflow]: https://github.com/imcf/imcf.github.io/actions/workflows/deploy-pages.yml

0 commit comments

Comments
 (0)