Skip to content

Commit

Permalink
Readme fixed for Docker usage
Browse files Browse the repository at this point in the history
  • Loading branch information
AdityaSeth777 committed May 16, 2024
1 parent 60a57ee commit d7653dd
Showing 1 changed file with 22 additions and 15 deletions.
37 changes: 22 additions & 15 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,6 @@ Audio-SpectraCLI/
main.py
```

## Installation Types:

├───Using PIP <br>
├───Using Docker <br>
└───Using Docker locally <br>

## Installation & Usage (Using PIP)

1. Install using pip
Expand Down Expand Up @@ -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).
Expand All @@ -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
Expand All @@ -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:

Expand All @@ -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
Expand Down

0 comments on commit d7653dd

Please sign in to comment.