Skip to content

Commit 95a13bb

Browse files
committed
Update README.md
1 parent 5c98178 commit 95a13bb

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,36 +28,36 @@ This framework has been developed as part of the _"A Bug's Life: Analyzing the L
2828
BugHog is compatible with UNIX systems running Docker, including WSL on Windows.
2929
Follow these steps to get started:
3030

31-
1. **Clone this repository:**
31+
### 1. Clone this repository:
3232

3333
```bash
3434
git clone https://github.com/DistriNet/BugHog
3535
cd BugHog
3636
```
3737

38-
2. **Obtain images:**
38+
### 2. Obtain images:
3939

40-
You will need at least 5 GB of disk space.
41-
There are two options available to obtain the BugHog images, and you can switch between them by executing the appropriate command.
40+
You will need at least 5 GB of disk space.
41+
There are two options available to obtain the BugHog images, and you can switch between them by executing the appropriate command.
4242

43-
***Option A:** Pulling (fastest)*
43+
#### Option A: Pulling (fastest)
4444

45-
Use the following command to pull the necessary Docker images:
46-
```bash
47-
docker compose pull core worker nginx
48-
```
45+
Use the following command to pull the necessary Docker images:
46+
```bash
47+
docker compose pull core worker nginx
48+
```
4949

50-
> [!NOTE]
51-
> If you prefer to use a version other than the latest, simply modify the `BUGHOG_VERSION` and / or `BUGHOG_WEB_VERSION` variables accordingly.
50+
> [!NOTE]
51+
> If you prefer to use a version other than the latest, simply modify the `BUGHOG_VERSION` and / or `BUGHOG_WEB_VERSION` variables accordingly.
5252
53-
***Option B:** Building*
53+
#### Option B: Building
5454

55-
Use the following commands to build the Docker images yourself, for instance after you made changes to the source code:
56-
```bash
57-
docker compose build core worker nginx
58-
```
59-
> [!NOTE]
60-
> For reference, building takes about 4 minutes on a machine with 8 CPU cores and 8 GB of RAM.
55+
Use the following commands to build the Docker images yourself, for instance after you made changes to the source code:
56+
```bash
57+
docker compose build core worker nginx
58+
```
59+
> [!NOTE]
60+
> For reference, building takes about 4 minutes on a machine with 8 CPU cores and 8 GB of RAM.
6161
6262

6363
## Usage

0 commit comments

Comments
 (0)