From c2661ff05bde66761224c41167c9cc7ad409722a Mon Sep 17 00:00:00 2001
From: NaokiHori <36466440+NaokiHori@users.noreply.github.com>
Date: Mon, 3 Feb 2025 21:50:24 +0900
Subject: [PATCH] [mod] readme

---
 README.md  | 61 ++++++++++++++++++++++++++++++++++++++++++
 README.rst | 78 ------------------------------------------------------
 2 files changed, 61 insertions(+), 78 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.rst

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a5893fa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+# Simple IBM Solver
+
+[![License](https://img.shields.io/github/license/NaokiHori/SimpleIBMSolver)](https://opensource.org/licenses/MIT)
+[![Last Commit](https://img.shields.io/github/last-commit/NaokiHori/SimpleIBMSolver/main)](https://github.com/NaokiHori/SimpleIBMSolver/commits/main)
+
+[![Simulation Snapshot](https://github.com/NaokiHori/SimpleIBMSolver/blob/main/docs/source/snapshot2d.png)](https://youtu.be/nMAyrIYET10)
+
+## Overview
+
+This library numerically simulates the motion of rigid particles in two- and three-dimensional Cartesian domains using the finite-difference and immersed boundary methods.
+
+## Dependency
+
+This solver is built on top of [`SimpleNSSolver`](https://github.com/NaokiHori/SimpleNSSolver). 
+Please check its repository for dependency details.
+
+## Quick Start
+
+1. **Set up your workspace**
+
+   ```console
+   mkdir -p /path/to/your/directory
+   cd /path/to/your/directory
+   ```
+
+2. **Clone the repository**
+
+   ```console
+   git clone --recurse-submodules https://github.com/NaokiHori/SimpleIBMSolver
+   cd SimpleIBMSolver
+   ```
+
+3. **Set the initial condition**
+
+   Python 3 is used to conveniently initialize the flow fields. 
+   Alternatively, `NPY` files can be provided in a different manner under `initial_condition/output/`.
+
+   ```console
+   cd initial_condition
+   make output
+   bash exec.sh
+   cd ..
+   ```
+
+4. **Build the solver**
+
+   ```console
+   make output
+   make all
+   ```
+
+5. **Run the simulation**
+
+   ```console
+   bash exec.sh
+   ```
+
+## Note
+
+The immersed boundary method and the collision model are based on [this publication](https://www.sciencedirect.com/science/article/pii/S0045793021003716) with some modifications.
+
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 961dd3a..0000000
--- a/README.rst
+++ /dev/null
@@ -1,78 +0,0 @@
-#################
-Simple IBM Solver
-#################
-
-|License|_ |LastCommit|_
-
-.. |License| image:: https://img.shields.io/github/license/NaokiHori/SimpleIBMSolver
-.. _License: https://opensource.org/licenses/MIT
-
-.. |LastCommit| image:: https://img.shields.io/github/last-commit/NaokiHori/SimpleIBMSolver/main
-.. _LastCommit: https://github.com/NaokiHori/SimpleIBMSolver/commits/main
-
-.. image:: https://github.com/NaokiHori/SimpleIBMSolver/blob/main/docs/source/snapshot2d.png
-   :target: https://youtu.be/nMAyrIYET10
-   :width: 100%
-
-********
-Overview
-********
-
-This library numerically solves the motion of moving rigid particles in two- and three-dimensional Cartesian domains using the finite-difference and the immersed boundary methods.
-
-**********
-Dependency
-**********
-
-This is built on top of `SimpleNSSolver <https://github.com/NaokiHori/SimpleNSSolver>`_.
-Please visit it and check the dependency there.
-
-***********
-Quick start
-***********
-
-#. Prepare workplace
-
-   .. code-block:: console
-
-      mkdir -p /path/to/your/directory
-      cd       /path/to/your/directory
-
-#. Get source
-
-   .. code-block:: console
-
-      git clone --recurse-submodules https://github.com/NaokiHori/SimpleIBMSolver
-      cd SimpleIBMSolver
-
-#. Set initial condition
-
-   Here ``Python3`` is used to initialise the flow fields conveniently.
-   One can give ``NPY`` files in different way under ``initial_condition/output/``.
-
-   .. code-block:: console
-
-      cd initial_condition
-      make output
-      bash exec.sh
-      cd ..
-
-#. Build solver
-
-   .. code-block:: console
-
-      make output
-      make all
-
-#. Run
-
-.. code-block:: console
-
-   bash exec.sh
-
-****
-Note
-****
-
-The immersed boundary method and the collision model is based on `a publication <https://www.sciencedirect.com/science/article/pii/S0045793021003716>`_ with some modifications.
-