Skip to content

Commit d2df42d

Browse files
committed
Improved the readability of readme file
1 parent baec208 commit d2df42d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ In future versions, Inmart aims to include:
9797
Below are the steps to install and run Inmart using Docker. No technical background is needed — simply follow these instructions carefully.
9898

9999
### Step 1: Install Docker
100-
100+
```
101101
You need to install Docker on your system before running Inmart.
102102
103103
- **Windows:**
@@ -106,17 +106,17 @@ You need to install Docker on your system before running Inmart.
106106
[Install Docker for Mac](https://docs.docker.com/desktop/setup/install/mac-install/)
107107
- **Linux:**
108108
[Install Docker for Linux](https://docs.docker.com/desktop/setup/install/linux/)
109-
109+
```
110110
### Step 2: Clone the Codebase
111-
111+
```
112112
Open a terminal or command prompt and run the following command:
113113
114114
git clone https://github.com/chaitanyakadu/inmart.git
115115
116116
This will download the entire Inmart project onto your computer.
117-
117+
```
118118
### Step 3: Run Setup Script
119-
119+
```
120120
Before starting Inmart, you need to provide your API credentials for Google, MailJet, and Gemini.
121121
122122
1. **Get Google Credentials:**
@@ -135,17 +135,17 @@ Once you have them ready, run the following commands:
135135
./scripts/setup.sh
136136
137137
These will configure the environment for your Inmart installation.
138-
138+
```
139139
### Step 4: Start Inmart Using Docker
140-
140+
```
141141
To start the Inmart system, run:
142142
143143
docker compose up -d
144144
145145
This will download all necessary containers and start the automation software.
146-
146+
```
147147
### Step 5: Stopping and Managing Inmart
148-
148+
```
149149
You can manage Inmart using the following commands:
150150
151151
#### To start Inmart
@@ -161,7 +161,7 @@ docker compose stop
161161
docker compose down
162162
163163
When you are done using Inmart, you can safely stop it with `docker compose down`.
164-
164+
```
165165
---
166166

167167
## Summary

0 commit comments

Comments
 (0)