Skip to content

Commit f7698d9

Browse files
Rearranged README.md
1 parent 9d8d238 commit f7698d9

1 file changed

Lines changed: 24 additions & 44 deletions

File tree

README.md

Lines changed: 24 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,53 @@
11
# About
22

33
Opus is a work-in-progress Minecraft Discord bot written in C.
4+
There are two ways to run Opus:
5+
1. Natively on your machine
6+
2. Through docker
47

5-
---
8+
I recommend running opus with the makefile as it is simpler,
9+
and if you encounter any issues with dependencies, try docker instead.
610

7-
## Installation
811

9-
You can run Opus using either `Docker` or directly with the `Makefile`.
12+
## Dependencies
1013

11-
### Option 1: Docker (Recommended for simplicity)
12-
13-
- **Docker** is the only dependency required for this option.
14-
15-
### Option 2: Using Makefile
14+
##### Using docker
15+
- just **Docker**
1616

17+
##### Running directly
1718
If you opt to use the `Makefile` directly, please check the `dependencies` file for a comprehensive list of the project's dependencies. The dependencies listed in the `dependencies` file are for a minimal installation of Alpine Linux.
1819

19-
> **Note**: If you're using a package-rich distribution like Ubuntu, some dependencies (e.g., `musl-dev` for basic C libraries) may already be installed.
20-
21-
#### Required Dependencies (for Makefile option)
2220
- **Make**
2321
- **Clang**
2422
- **Valgrind***
25-
- **Bash*** <br> <br> <br>
23+
- **Bash***
24+
2625
*required only for running test suite
27-
## Building
2826

29-
This step is only necessary if you're using Docker to run Opus.
27+
> **Note**: If you're using a package-rich distribution like Ubuntu, some dependencies in the `dependencies` file (e.g., `musl-dev` for basic C libraries) may already be installed.
3028
31-
**Build the main image**:
29+
## Execution
3230

33-
```bash
34-
docker build -t Opus .
35-
```
31+
You can choose to run either the discord bot or the test suite.
3632

37-
**Build the test suite image**:
33+
### Build & Run with Docker
3834

35+
##### Opus
3936
```bash
40-
docker build --build-arg directory=tests -t Opus/tests .
37+
docker build -t Opus .
38+
docker run Opus
4139
```
4240

43-
## Running
44-
45-
You can run Opus either through the `Makefile` or `Docker`.
46-
47-
### Option 1: Using Makefile (Recommended)
48-
49-
**Run the main program**:
50-
41+
##### Opus test suite
5142
```bash
52-
make run
43+
docker build --build-arg directory=tests -t Opus/tests .
44+
docker run Opus/tests
5345
```
5446

55-
**Run the test suite** (navigate to `tests` directory first):
47+
### Makefile
5648

49+
The command to run the test suite is the same as running the program,
50+
but to run tests you must be in the `tests` directory.
5751
```bash
5852
make run
5953
```
60-
61-
### Option 2: Using Docker
62-
63-
**Run the main program**:
64-
65-
```bash
66-
docker run Opus
67-
```
68-
69-
**Run the test suite**:
70-
71-
```bash
72-
docker run Opus/tests
73-
```

0 commit comments

Comments
 (0)