From 8a98ceab8cc969f51fd162db4fb8bb81e2290185 Mon Sep 17 00:00:00 2001 From: Kenneth Jao Date: Mon, 17 Jun 2024 19:18:53 -0500 Subject: [PATCH] README to RST format --- README.rst | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index eb90c2a..6bdeed2 100644 --- a/README.rst +++ b/README.rst @@ -1,33 +1,36 @@ -# Docker 101 - -## Description - +========== +Docker 101 +========== This repository documents my understanding of Docker and my attempt to build a Docker image for DGTD (Discontinuous Galerkin Time Domain) code. Docker allows us to package applications and their dependencies into isolated containers, ensuring consistency across different environments. The documentation is up `here `__. -## Building the Docker Image +Building the Docker Image +------------------------- To build the Docker image for DGTD code, follow these steps: -### Command Line Interface (CLI) +Command Line Interface (CLI) +---------------------------- Use the following CLI commands to build the Docker image: -```bash -docker build -t sample-image . -``` +.. code-block:: sh + + docker build -t sample-image . Replace `sample-image` with your preferred image name. -### Platform Compatibility +Platform Compatibility +---------------------- The Docker image can be built on both UNIX and Windows platforms. Here’s how I set it up: - **UNIX:** Use Docker Engine. - **Windows:** Install Docker Desktop. -## Testing the Docker Image +Testing the Docker Image +------------------------ After building the Docker image, test its functionality on both UNIX and Windows environments: @@ -36,7 +39,8 @@ After building the Docker image, test its functionality on both UNIX and Windows The image should maintain consistency and reproducibility across platforms, demonstrating Docker's versatility in managing application dependencies. -## Usage +Usage +----- This repository serves as a guide for packaging DGTD code and other applications in Docker containers in the future. Adjust Dockerfile configurations and testing procedures as necessary for specific application requirements.