diff --git a/README.md b/README.md index e3f0a5a3..32d5e825 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ -# h1-mod \ No newline at end of file +# H1-Mod 1.4 + +

+ +

+ +Proof of concept for an Modern Warfare Remastered client.
+[This project is based on S1x](https://github.com/XLabsProject/s1x-client) + +- [h1_full_game 1.4.torrent](https://cdn.discordapp.com/attachments/895679269089448016/934624869826580530/h1_full_files.torrent) + +## Compile from source + +- Clone the Git repo. Do NOT download it as ZIP, that won't work. +- Update the submodules and run `premake5 vs2019` or simply use the delivered `generate.bat`. +- Build via solution file in `build\h1-mod.sln`. + +### Premake arguments + +| Argument | Description | +|:----------------------------|:-----------------------------------------------| +| `--copy-to=PATH` | Optional, copy the EXE to a custom folder after build, define the path here if wanted. | +| `--dev-build` | Enable development builds of the client. | + +
+ +## Disclaimer + +This software has been made for learning purposes.