From 6816fc7c3575a355885e01a9473410b46efe9bc6 Mon Sep 17 00:00:00 2001
From: IIMKGII <66014248+IIMKGII@users.noreply.github.com>
Date: Fri, 31 Mar 2023 19:28:57 +0200
Subject: [PATCH] Create README.md

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..62f3075
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# VA Tactic Planer
+
+VA Tactic Planer is a tool designed for the virtual reality FPS game, Pavlov VR. This tool enables players to plan their tactics and strategies by drawing on a top-down view of the game's maps. Users can also add icons to the map to represent players or objectives. Additionally, users can take screenshots with or without text fields for better communication.
+
+## Getting Started
+
+To start using VA Tactic Planer, you must first generate the folder structure by running the program once. After that, you can place your maps and callout maps in the following directory: `C:\Users\username\AppData\LocalLow\IIMKGII\PavlovStrategyPlaner\Maps` and `C:\Users\username\AppData\LocalLow\IIMKGII\PavlovStrategyPlaner\CalloutMaps`.
+
+## Features
+
+VA Tactic Planer provides the following features:
+
+- Drawing: Use numbers 1-8 to draw with different size pens. Arrows up/down can be used to increase/decrease the size of the pen.
+- Icons: Use letters Q-Z to add icons to the map to represent players or objectives. The delete key can be used to delete icons.
+- Screenshots: Take screenshots with F11 (without text field) and F12 (with text field) to share your strategy with your team.
+
+## Contributing
+
+If you would like to contribute to VA Tactic Planer, feel free to open an issue or submit a pull request. Any feedback or contributions are greatly appreciated.
+
+## License
+
+VA Tactic Planer is licensed under the MIT License. Please see the `LICENSE` file for more information.