From f1efee768016310a7f58fa6253d1595998f5e9d5 Mon Sep 17 00:00:00 2001 From: Michael Kuhn Date: Thu, 3 Oct 2024 10:08:30 -0600 Subject: [PATCH] remove incflo README, correct API docs link, modify references to documentation --- README.md | 9 +++++---- README_incflo.md | 31 ------------------------------- 2 files changed, 5 insertions(+), 35 deletions(-) delete mode 100644 README_incflo.md diff --git a/README.md b/README.md index c981ead1d8..1756a327af 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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. diff --git a/README_incflo.md b/README_incflo.md deleted file mode 100644 index 1c2eeff29c..0000000000 --- a/README_incflo.md +++ /dev/null @@ -1,31 +0,0 @@ -# Directory overview - -| File | Description | -| ----------| --------------------------------------------------- | -| exec | Run directory for executables | -| src | C++/Fortran source files | - - -# Using incflo - -## Build AMReX Library - -Clone AMReX from the official Git repository and checkout the _development_ branch. -```shell -> git clone https://github.com/AMReX-Codes/amrex.git -> cd amrex -> git checkout development -``` - -## Build and run an example incflo problem -Clone and build incflo -```shell -> git clone http://github.com/AMReX-Codes/incflo.git -> cd exec -> make -j4 -> mpirun -np 4 incflo3d.gnu.MPI.ex inputs.channel_cylinder -``` - -# Contributing - -We welcome contributions in the form of pull-requests from anyone.