Skip to content

Commit

Permalink
Add Nextflow logo to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ewels committed Mar 12, 2024
1 parent 240071c commit 882d658
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
<picture>
<source media="(prefers-color-scheme: dark)" srcset="public/img/nextflow_darkbg.svg">
<source media="(prefers-color-scheme: light)" srcset="public/img/nextflow.svg">
<img alt="Nextflow Logo" src="public/img/nextflow.svg">
</picture>

# Nextflow web site

[nextflow.io](https://nextflow.io) is a static web site. Pages are generated by using [Astro](https://astro.build).
Source code for [https://nextflow.io](https://nextflow.io). Website is generated using [Astro](https://astro.build).

## Commands

There is a `Makefile` with a few standard commands for working with the website:
To build the website you need Node.js and `npm` installed. See the [npm docs](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) for instructions.

<!-- TODO: We can replace the Makefile with `npm run` scripts in package.json -->

There is a `Makefile` in the repo with a few standard commands for working with the website:

| Command | Action |
| :---------------- | :----------------------------------- |
Expand All @@ -13,7 +23,7 @@ There is a `Makefile` with a few standard commands for working with the website:
| `make publish` | Publish the website to s3 |
| `make invalidate` | Invalidate the Cloudfront cache |

The `dev` server builds pages on request and live-updates as you make changes. It includes additional debugging tools, but does not do all type-checking.
The `dev` server builds pages on request and live-updates as you make changes. It includes additional debugging tools. Note that some type-checking on happens during `make build`.

There are also a bunch of `npm` commands for more fine-grained control:

Expand Down
14 changes: 14 additions & 0 deletions public/img/nextflow_darkbg.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 882d658

Please sign in to comment.