From d7653dd2372575261e6616bc1334fa9cc8df20d8 Mon Sep 17 00:00:00 2001 From: AdityaSeth777 Date: Thu, 16 May 2024 20:58:21 +0530 Subject: [PATCH] Readme fixed for Docker usage --- Readme.md | 37 ++++++++++++++++++++++--------------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/Readme.md b/Readme.md index f7be0e4..df60de3 100644 --- a/Readme.md +++ b/Readme.md @@ -43,12 +43,6 @@ Audio-SpectraCLI/ main.py ``` -## Installation Types: - -├───Using PIP
-├───Using Docker
-└───Using Docker locally
- ## Installation & Usage (Using PIP) 1. Install using pip @@ -77,7 +71,7 @@ Once you have activated the audio_visualizer instance, feel free to use it where --- -## Installation & Usage (Using Docker) +## Examining & Usage for fun :D (Using Docker) 1. Prerequisites You should have docker installed on your machine. You can download and install Docker from [here](https://www.docker.com/products/docker-desktop). @@ -89,14 +83,20 @@ You can pull the pre-built Docker image from Docker Hub using the following comm docker pull adityaseth777/audio-spectracli ``` -3. Running the Docker Container - To run the Docker container, use the following command: +3. Viewing Files Inside the Docker Container + For seeing the files inside the Docker container for debugging purposes, you can run an interactive shell session: +```sh +docker run --rm -it --entrypoint /bin/bash audio-spectracli ``` -docker run --rm -it adityaseth777/audio-spectracli + +4. Use the 'ls' command to view the files and get a proper understanding of the file structure : + +```sh +ls ``` -4. You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/main/tests/main.py) as a reference or use the following code : +5. You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/main/tests/main.py) as a reference or use the following code : ``` from Audio_SpectraCLI import AudioSpectrumVisualizer @@ -113,7 +113,7 @@ Once you have activated the audio_visualizer instance, feel free to use it where --- -## Building the Docker Image Locally +## Building the Docker Image Locally (for fun :D) If you prefer to build the Docker image locally, follow these steps: @@ -130,13 +130,20 @@ cd Audio-SpectraCLI docker build -t audio-spectracli . ``` -3. Run the Docker container: +3. Viewing Files Inside the Docker Container + For seeing the files inside the Docker container for debugging purposes, you can run an interactive shell session: + +```sh +docker run --rm -it --entrypoint /bin/bash audio-spectracli +``` + +4. Use the 'ls' command to view the files and get a proper understanding of the file structure : ```sh -docker run --rm -it audio-spectracli +ls ``` -4. You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/main/tests/main.py) as a reference or use the following code : +5. You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/main/tests/main.py) as a reference or use the following code : ``` from Audio_SpectraCLI import AudioSpectrumVisualizer