Skip to content

Commit

Permalink
docs(readme): description to how use the project
Browse files Browse the repository at this point in the history
  • Loading branch information
TheRealPad committed Feb 28, 2024
1 parent cf08938 commit 0ffef6f
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,28 @@

# Calculator

a c++ calculator to handle infinite numbers
a c++ calculator to handle infinite numbers

## How to use

### 1. Create a directory build and go inside
```bash
mkdir build && cd build/
```
### 2. Build the project
```bash
cmake ..
```
### 3. Build the binaries
```bash
make
```
### 4. Run the project
```bash
# go back to the root of the project
./johnDoe
```
### 5. Unit test
```bash
./unit_test
```

0 comments on commit 0ffef6f

Please sign in to comment.