init

README.md

@@ -0,0 +1,28 @@
+# IW4: SP Client
+
+This is a client modification for IW4 (Singleplayer) 159
+**NOTE**: You must legally own Call of Duty®: Modern Warfare® 2 (2009) to run this mod. Cracked/Pirated versions of the game are **NOT** supported.
+
+## How to compile
+
+This project requires [Git](https://git-scm.com), [Premake5](https://premake.github.io), and [MSVC](https://visualstudio.microsoft.com/vs/features/cplusplus) to build.
+
+- Run `premake5 vs2022` or use the delivered `generate.bat`.
+- Build via solution file found in `build\iw4-sp.sln`.
+
+## Premake arguments
+
+| Argument                    | Description                                    |
+|:----------------------------|:-----------------------------------------------|
+| `--copy-to=PATH`            | Optional, copy the exe to a custom folder after build. |
+
+## Contributing
+
+Contributions are welcome! Please follow the guidelines below:
+
+- Sign [AlterWare CLA](https://alterware.dev/cla) and send a pull request or email your patch at patches@alterware.dev
+- Make sure that PRs have only one commit, and deal with one issue only
+
+## Disclaimer
+
+This software has been created purely for the purposes of academic research. It is not intended to be used to attack other systems. Project maintainers are not responsible or liable for misuse of the software. Use responsibly.