Skip to content

Commit

Permalink
Use same content for knowledge requirement warnings, update CMake ver…
Browse files Browse the repository at this point in the history
…sion warning
  • Loading branch information
SamVanheer committed Jan 27, 2024
1 parent c871918 commit 97252b0
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
4 changes: 2 additions & 2 deletions BUILDING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Building this SDK

This tutorial expects a strong grasp of the basics of command line interfaces, version control, build systems (CMake, Visual Studio, Makefiles) and C++.
This tutorial expects a strong grasp of of C++, build systems like Visual Studio or Make (depending on the platform you're developing for), CMake, command line interfaces and version control systems (Git in particular).

All instructions for Linux development are written to apply to Ubuntu. Substitute commands and actions as needed for your distribution. It is expected that you understand how to work with the Linux terminal and command line.

## Minimum requirements

The minimum requirements for this project are:
* [CMake 3.23 or newer](https://cmake.org/download/) (Note: avoid versions 3.28 and newer for now as it fails to download vcpkg dependencies. See [this](https://github.com/microsoft/vcpkg/issues/33904) issue for more information)
* [CMake 3.23 or newer](https://cmake.org/download/) (**Note**: avoid versions 3.28 and 3.28.1 as they fail to download vcpkg dependencies. See [this](https://github.com/microsoft/vcpkg/issues/33904) issue for more information)

### For Windows development

Expand Down
2 changes: 1 addition & 1 deletion DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Prerequisite knowledge

You will need a working knowledge of command line interfaces, CMake and C++ to make a mod with this SDK.
You will need a strong grasp of of C++, build systems like Visual Studio or Make (depending on the platform you're developing for), CMake, command line interfaces and version control systems (Git in particular) to make a mod with this SDK.

Various configuration files use JSON so an understanding of its syntax is recommended.

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ The [Half-Life Unified SDK](docs/README.md#developer-resources) is a project tha
The SDK provides a CMake-based project structure with support for Visual Studio 2019 and 2022 on Windows and GCC 11 on Linux, as well as many bug fixes and improvements.
Opposing Force and Blue Shift features have been integrated with code refactored to reduce the amount of code duplication.

**You will need a strong grasp of of C++, build systems like Visual Studio or Make (depending on the platform you're developing for), CMake, command line interfaces and version control systems (Git in particular) to make a mod with this SDK. If you do not have experience with these technologies then you will have a very hard time getting started.**

The goal of the Unified SDK is to allow modders to make mods based on these games, while providing bug fixes that could be applied to the official games as well in addition to bug fixes that would be a breaking change. Check out the documentation linked below for a list of features.

A mod installation is also provided to allow players to play these games with all bug fixes applied. It includes files that are required when making a mod based on this SDK.
Expand Down

0 comments on commit 97252b0

Please sign in to comment.