From a79ee36dd2d133b60a988d54dc91641533c70cad Mon Sep 17 00:00:00 2001
From: eiymba <25769322+eiymba@users.noreply.github.com>
Date: Sat, 5 Nov 2022 04:33:12 +0000
Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20Updated=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md |  121 ++++++++++++++++++++++++-------------------------------------
 1 file changed, 47 insertions(+), 74 deletions(-)

diff --git a/README.md b/README.md
index 3ff0ef4..0f3fe64 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-![Arc-HUD Splash Screen](https://i.imgur.com/PSgNCkn.png)
-# Arc-HUD
+![Arcadia HUD Splash Screen](https://i.imgur.com/rE77bRj.png)
+# Arcadia HUD
 
  ## [Based on the popular ArcHUB3 project by nyyr](https://github.com/nyyr/ArcHUB3)!
 
@@ -22,93 +22,66 @@
 
 ## What is Arc-HUD?
 
-Arc-HUD displays smooth arcs around your character in the middle of the screen to inform you about the health and power (mana, rage, ...) of you, your pet, and your target. In addition, it shows casts, combo points, holy power, soul shards, and a couple of other things. It discretely fades when you are out of combat and at full health/power.
+`Arc-HUD` displays smooth arcs around your character in the middle of the screen to inform you about the `health` and `power` (`mana`, `rage`, ...) of you, your pet, and your target. In addition, it shows casts, combo points, holy power, soul shards, and a couple of other things. It discretely fades when you are out of combat and at full health/power.
 
-These arcs are currently supported:
+## Contributing
+### Prerequisites
 
-* Health and power (mana, rage, focus, energy, runic power) for player, pet, target, and focus target
-* Player's secondary power (Holy Power, Soul Shards, Chi etc.)
-* Casting/channelling progress for player, target, and focus target
-* Fatigue/breath (mirror timer)
-* Combo points (including unconsumed combo points on previous target, e.g. on dead corpses)
-* Custom (de)buff arcs: Ever wanted to keep track of the stacks and/or remaining times of some specific (de)buffs such as Evangelism, Savage Roar, Beacon of Light, Weakened Soul, etc? Then just create your own custom (de)buff arc for it!
+- [ ] You have a [GitHub account](https://github.com).
+- [ ] You have a [GPG key set up to sign your commits]().
 
-In addition, some additional target information is displayed:
+Please also read the [Contributing](./docs/CONTRIBUTING.md) document and the [Code of Conduct](./docs/CODE_OF_CONDUCT.md).
 
-* Current target (name, class, guild, 3D model)
-* Current (de)buffs on target
-* Target-of-target and target-of-target-of-target
+### Getting Started
 
-<!-- This is a continuation of ArcHUD2 which managed to survive various patches... until the Cataclysm. Thanks to Nenie, the original author of ArcHUD2, for supporting me with this new version.
+>⚠️ **Note:** If you currently have **Arc-HUD** installed, it is generally recommended that you disabled it before installing the development version. Otherwise, you'll have both versions displayed in your UI at the same time.
 
-Please report any bugs or feature requests via the ticket system. The login is the same as your Curse login.
+1. Fork the repository
+2. Clone your fork to your local machine, for example:
+    - With SSH (recommended):
+        ```sh
+            git clone --recursive-submodules git@github.com:YOUR_USERNAME/arc-hud.git 
+        ```
+    - With HTTPS:
+        ```sh
+            git clone --recursive-submodules https://github.com/YOUR_USERNAME/arc-hud.git
+        ```
+3. Change directory to the cloned repository, for example:
 
-These arcs are currently supported:
+    ```sh
+        cd ./arc-hud
+    ```
+4. Open the directory with your favorite editor, for example (assuming VS Code is being used):
 
-* Health and power (mana, rage, focus, energy, runic power) for player, pet, target, and focus target
-* Player's secondary power (Holy Power, Soul Shards, Chi etc.)
-* Casting/channelling progress for player, target, and focus target
-* Fatigue/breath (mirror timer)
-* Combo points (including unconsumed combo points on previous target, e.g. on dead corpses)
-* Custom (de)buff arcs: Ever wanted to keep track of the stacks and/or remaining times of some specific (de)buffs such as Evangelism, Savage Roar, Beacon of Light, Weakened Soul, etc? Then just create your own custom (de)buff arc for it!
+    ```sh
+        code .
+    ```
 
-In addition, some additional target information is displayed:
+5. Build the project by running the following command:
 
-* Current target (name, class, guild, 3D model)
-* Current (de)buffs on target
-* Target-of-target and target-of-target-of-target
+    - Windows:
+        ```sh
+            .\build.ps1
+        ```
 
-Small warning: Using this addon apparently bears a high risk of getting addicted to it, as these user comments suggest. I received those after taking over the development of ArcHUD when the Cataclysm happened:
-
-* "...nothing ever quite matched the smooth, clean simplicity of ArcHUD's graceful rings."
-* "Great job!! I've used this addon for years! None of the other HUDs come close to the functionality and elegance of ArcHUD."
-* "Thanks for the work on it so far, much more lightweight than IceHud!"
-* "Was staring at the various icehud/metahud alternatives with discomfort and sadness right after the patch [4.0]."
-* "Awesome! Thank you so much for that miracle!"
-* "Thank you so much for continuing this fantastic addon."
-* "...nothing could compare to ArcHUD..."
-* "For a whole 4years I had this mod and I missed it so much in the passed few weeks. I tried other HUD mods but they were too in my face >.< . Best HUD mod IMO! Thanks for resurrecting an old friend :D"
-* "Loving the new ArcHUD my favorite HUD by far :)"
-* "I don't think I could play wow without this addon :)"
-* "I've actually grown kind of dependent on it because I'll occasionally run out of Mana/ die without this."
-* "Hey mate, just came to thank You again for taking over this beauty, awesome job!"
-* "THAT addon! So long I have been searching for a replacement when the development stopped, thanks for bringing it back to live!"
-
-So use it at your own risk ;)
-
-## Download
-
-For current retail version of WoW:
-
-* On Github under [releases](https://github.com/nyyr/ArcHUD3/releases)
-* On [WoW Interface](http://www.wowinterface.com/downloads/info24629-ArcHUD3.html)
-* On [WowAce](https://www.wowace.com/projects/archud3)
-* On [CurseForge](https://www.curseforge.com/wow/addons/archud3)
-
-For current WoW Classic:
-
-* On Github under [releases](https://github.com/nyyr/ArcHUD3/releases)
-* On [WoW Interface](https://www.wowinterface.com/downloads/info25227-ArcHUD3Classic.html)
-* On [WowAce](https://www.wowace.com/projects/archud3-classic)
-* On [CurseForge](https://www.curseforge.com/wow/addons/archud3-classic)
-
-## Frequently Asked Questions
-
-* How do I add [a arc for a specific buff/debuff (remaining time & stacks)](https://github.com/nyyr/ArcHUD3/issues/36)?
-* Where is my [Combo Point/Soul Shard Numeric Indicator](https://github.com/nyyr/ArcHUD3/issues/35)?
-
-## Developer Notes
-
-* [Change log](Docs/changelog.md)
-* [Ring Prototypes](Docs/ring-prototypes.txt) (a bit outdated)
-* [Maths behind the rings](Docs/statrings.txt)
-* [History](Docs/history.txt)
-* [Publishing via Travis CI](http://www.wowinterface.com/forums/showthread.php?t=55801) -->
+    - Linux:
+        ```sh
+            ./build.sh
+        ```
 
+This will package the addon in the `./build` directory as a `.zip` file, and extract it in every version of WoW installed on your machine.  For more information, see the [build](./docs/BUILDING.md) document.
 
+If compiled successfully, you should see `Arc-HUD-<version>` in your AddOns list in game. _You may need to select `Load out of date AddOns` in the `Interface Options` menu._
 ## Further Links
 
 * [Changelog](./CHANGELOG.md)
 * [Issues](https://github.com/eiymba/arc-hud/issues)
-* [Contributing](./Contributing.md)
+* [Contributing](./docs/Contributing.md)
+
+## License
+
+Arcadia is licensed under the [GNU General Public License v2.0](./LICENSE).
+
+## Credits
 
+* [rookdorf](https://github.com/rookdorf)
\ No newline at end of file
-- 
1.7.9.5