backup/OpenDX
1
0
Fork 0
mirror of https://github.com/EduApps-CDG/OpenDX synced 2024-12-30 09:45:37 +01:00
Code Issues Projects Releases Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Eduardo P. Gomez 2023-09-21 02:23:17 -03:00 committed by GitHub
parent 0acfbbebe6
commit dc8c1d600a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -1,5 +1,5 @@
# Contributing
This guide shows how to prepare your environment to contribute for OpenDX.
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:
@ -15,12 +15,17 @@ This guide shows how to prepare your environment to contribute for OpenDX.
## Building and running
These are the same universal steps for cmake:
**Build:**
```sh
./build.sh
```
----
**Run:**
```sh
cd build #for running
./dxdiag #runs dxdiag
./tests/sample #runs test sample
```
#setups the terminal for better running.
PATH=$PATH:./build/root/usr/bin
#commands available to run:
dxdiag
sample
```