Skip to content

Commit 116c728

Browse files
committed
docs: Add missed pull request docs
1 parent 633c0d9 commit 116c728

File tree

4 files changed

+556
-1
lines changed

4 files changed

+556
-1
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!--
2+
Before submitting a pull request, please read:
3+
4+
- the CONTRIBUTING guide at https://github.com/Source-Authors/Obsoletium/blob/HEAD/CONTRIBUTING.md
5+
- the commit message formatting guidelines at
6+
https://github.com/Source-Authors/Obsoletium/blob/HEAD/docs/contributing/PULL_REQUESTS.md#commit-message-guidelines
7+
8+
For code changes:
9+
1. Include tests for any bug fixes or new features.
10+
2. Update documentation if relevant.
11+
3. Ensure that tests pass.
12+
13+
If you believe this PR should be highlighted in the Obsoletium CHANGELOG
14+
please add the `notable-change` label.
15+
16+
Developer's Certificate of Origin 1.1
17+
18+
By making a contribution to this project, I certify that:
19+
20+
(a) The contribution was created in whole or in part by me and I
21+
have the right to submit it under the open source license
22+
indicated in the file; or
23+
24+
(b) The contribution is based upon previous work that, to the best
25+
of my knowledge, is covered under an appropriate open source
26+
license and I have the right under that license to submit that
27+
work with modifications, whether created in whole or in part
28+
by me, under the same open source license (unless I am
29+
permitted to submit under a different license), as indicated
30+
in the file; or
31+
32+
(c) The contribution was provided directly to me by some other
33+
person who certified (a), (b) or (c) and I have not modified
34+
it.
35+
36+
(d) I understand and agree that this project and the contribution
37+
are public and that a record of the contribution (including all
38+
personal information I submit with it, including my sign-off) is
39+
maintained indefinitely and may be redistributed consistent with
40+
this project or the open source license(s) involved.
41+
-->

BUILDING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,8 @@ Binaries at <https://github.com/Source-Authors/Obsoletium/releases> are produced
117117

118118
To run the games you need to _own_ ones. Check Steam store pages for Half-Life 2, Half-Life 2 Episode 1/2 or Portal and buy them. **Note you need ```steam_legacy``` branch for Half-Life 2 and episodes, as [`20th Anniversary Update`](https://www.half-life.com/en/halflife2/20th) not supported *yet***.
119119

120+
### Windows
121+
120122
#### Windows Prerequisites
121123

122124
* Git. Follow [`Git downloads`](https://git-scm.com/downloads).

docs/contributing/ARCHITECTURE_INTERNALS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ The **Obsoletium** repository on GitHub contains several top-level folders, each
88
|-----------------------|-----------------------------------------------------------------------------------------------------|
99
| **appframework** | Source code for basic applications using the Obsoletium platform. |
1010
| **bitmap** | Image format conversions, resampling and PSD, TGA files support. |
11+
| **build** | App version resources and manifests. |
1112
| **choreoobjects** | Choreo actors, channels, events and scenes. |
1213
| **common** | Contains the source code for common things. Slowly being removed / moved. |
1314
| **datacache** | Data caching functionality. |
@@ -20,7 +21,6 @@ The **Obsoletium** repository on GitHub contains several top-level folders, each
2021
| **docs** | Holds documentation files that provide guidance on using and contributing to the project. This may include setup instructions, API references, and user guides. |
2122
| **dx9sdk** | DirectX 9 SDK files which are not distributed by Windows SDK. |
2223
| **dx11sdk** | DirectX 11 SDK binaries used for shader compiling. |
23-
| **dx11sdk** | DirectX 11 SDK binaries used for shader compiling. |
2424
| **engine** | Engine to run the game app. |
2525
| **external** | External things needed for compilation. |
2626
| **fgdlib** | Game definition files parser library. |

0 commit comments

Comments
 (0)