This repository has been archived on 2024-12-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
OCRudoku/README.md
Louis Gallet db4c1da46f
All checks were successful
build / build (pull_request) Successful in 20s
docs: 📝 Create documentation to prepare and compile
2024-09-29 14:12:23 +02:00

42 lines
1.2 KiB
Markdown

# OCRudoku
## Prepare the project
### Install the required libraries
In order to make the project work, you need to install the following libraries:
- SDL2
- SDL2_image
- SDL2_ttf
You can install them using the following command (for Linux):
```bash
sudo apt-get install libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev
```
### Link dependencies to clang
In order to compile the project, you need to link the dependencies to clang. You can do this by running the following command:
```bash
sudo apt-get install bear -y
make prepare
```
## Compile the project
### Compile everything
You can compile the project by running the following command:
```bash
make
```
Output files will be generated in the `build` directory. You can run the project by executing the `ocrudoku` binary.
### Compile only one or multiple files (for debugging)
You can compile only one or multiple files by enter in the `src/`folder and running the following command:
```bash
make [file name]
```
For example, if you want to compile the `main.c` file, you can run the following command:
```bash
make main
```
Output files will be generated in the `src` directory. You can run the project by executing the `filename` binary.