Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README updates #1271

Merged
merged 1 commit into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AMR-Wind

[User manual](https://exawind.github.io/amr-wind) | [API docs](https://exawind.github.io/amr-wind/api_docs) | [Nightly test dashboard](http://my.cdash.org/index.php?project=Exawind)
[Documentation](https://exawind.github.io/amr-wind) | [API docs](https://exawind.github.io/amr-wind/api_docs) | [Nightly test dashboard](http://my.cdash.org/index.php?project=Exawind)

[![Powered by AMReX](https://amrex-codes.github.io/badges/powered%20by-AMReX-red.svg)](https://amrex-codes.github.io/amrex/) [![Build Status](https://github.com/Exawind/amr-wind/workflows/AMR-Wind-CI/badge.svg)](https://github.com/Exawind/amr-wind/actions) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9284/badge)](https://www.bestpractices.dev/projects/9284)

Expand Down Expand Up @@ -40,9 +40,10 @@ objectives:

## Documentation

Documentation is organized into a [user manual](https://exawind.github.io/amr-wind)
and a developer-focused [API
documentation](https://exawind.github.io/amr-wind). You can either
Documentation is available at https://exawind.github.io/amr-wind, which
includes a walkthrough tutorial, a user manual, notes on theory,
and tips for developers. We also provide a developer-focused [API
documentation](https://exawind.github.io/amr-wind/api_docs). You can either
browse the docs online by following the links, or you can generate them locally
after downloading the code. Please follow the instructions in user manual to
build documentation locally.
Expand Down
31 changes: 0 additions & 31 deletions README_incflo.md

This file was deleted.