1
0
mirror of https://github.com/EduApps-CDG/OpenDX synced 2024-12-30 09:45:37 +01:00
OpenDX/CONTRIBUTING.md

32 lines
796 B
Markdown
Raw Normal View History

# Contributing
2023-09-21 02:23:17 -03:00
This guide shows how to prepare your environment to contribute for OpenDX's DirectX reimplementation.
## Dependencies
`./build.sh` detect and try to install the dependencies for you, but if you want to do it manually, here is the list of dependencies:
| Dependency | Version |
|:-|-:|
|[`gcc`](https://packages.ubuntu.com/lunar/gcc)|`12.2.0`|
|[`cmake`](https://packages.ubuntu.com/lunar/cmake)|`3.25.1`|
|[`make`](https://packages.ubuntu.com/lunar/make)|`4.3`|
|[`libgtk-4-dev`](https://packages.ubuntu.com/lunar/libgtk-4-dev)|`4.10.1`|
## Building and running
These are the same universal steps for cmake:
2023-09-21 02:23:17 -03:00
**Build:**
```sh
./build.sh
```
2023-09-21 02:23:17 -03:00
**Run:**
```sh
2023-09-21 02:23:17 -03:00
#setups the terminal for better running.
PATH=$PATH:./build/root/usr/bin
#commands available to run:
dxdiag
sample
```