add README.md

LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2016-2023, Marco "eukara" Hladik <marco@icculus.org>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -0,0 +1,58 @@
+# FreeHL2
+Clean-room reimplementation of Half-Life 2 & Half-Life 2: Deathmatch in QuakeC.
+
+This is 100% original code, feel free to audit however you wish.
+No proprietary SDKs have been looked at or taken apart, unlike similar projects.
+
+The engine you want to use to run this is FTEQW (https://www.fteqw.org), which is a project unrelated to this. It just happens to support the file-formats FreeHL2 needs.
+
+![Preview 1](img/preview1.jpg)
+![Preview 2](img/preview2.jpg)
+![Preview 3](img/preview3.jpg)
+![Preview 4](img/preview4.jpg)
+
+## Building
+Clone the repository into the Nuclide-SDK:
+
+> git clone REPOURL hl2
+
+then either run Nuclide's ./build_game.sh shell script, or issue 'make' inside
+./hl2/src!
+
+Obviously make sure that Nuclide has fteqw and fteqcc set-up for building and that you have some proficiency in QuakeC.
+
+## Notes
+If you're playing a mod that relies on FreeHL2, selecting it from the Custom Game
+menu alone works fine. However if you want to launch it via the command-line
+you need to make sure to add `-game hl2` before `-game modname`.
+The order is important.
+
+## Community
+
+### Matrix
+If you're a fellow Matrix user, join the Nuclide Space to see live-updates and more!
+https://matrix.to/#/#nuclide:matrix.org
+
+### IRC
+Join us on #freecs via irc.libera.chat and talk/lurk or discuss bugs, issues
+and other such things. It's bridged with the Matrix room of the same name!
+
+### Others
+We've had people ask in the oddest of places for help, please don't do that.
+
+## License
+ISC License
+
+Copyright (c) 2016-2023 Marco Hladik <marco@icculus.org>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
+IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
+OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.