From e462ff167f8efca703f43faf130f98520493c6d8 Mon Sep 17 00:00:00 2001 From: pv Date: Tue, 22 Mar 2022 05:41:24 +0300 Subject: [PATCH] Update readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 067350d..e2a49ee 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ # TweakXL + +TweakXL is a modding tool that allows you to modify TweakDB. + +## Getting Started + +### Prerequisites + +- [RED4ext](https://docs.red4ext.com/getting-started/installing-red4ext) 1.4.0+ + +### Installation + +1. Download [the latest release](https://github.com/psiberx/cp2077-tweak-xl/releases) archive +2. Extract the archive into the Cyberpunk 2077 installation directory + +## Documentation + +- [About TweakDB](/psiberx/cp2077-tweak-xl/wiki/About-TweakDB) +- [YAML Tweaks](/psiberx/cp2077-tweak-xl/wiki/YAML-Tweaks) +- [Script Extensions](/psiberx/cp2077-tweak-xl/wiki/Script-Extensions) +- [Modder Tools](/psiberx/cp2077-tweak-xl/wiki/Modder-Tools) +- [Examples](/psiberx/cp2077-tweak-xl/wiki/Examples)