From 97252b0a6e6b2eb06d8f5d80d2603d851845e7b7 Mon Sep 17 00:00:00 2001 From: Sam V Date: Sat, 27 Jan 2024 20:01:50 +0100 Subject: [PATCH] Use same content for knowledge requirement warnings, update CMake version warning --- BUILDING.md | 4 ++-- DEVELOPING.md | 2 +- README.md | 2 ++ 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 4bbfe45a5..36153d31d 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -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 diff --git a/DEVELOPING.md b/DEVELOPING.md index c447310c9..cc2e3f810 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -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. diff --git a/README.md b/README.md index 5b0c1e688..217f77c02 100644 --- a/README.md +++ b/README.md @@ -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.