From 54450db9099a051a03af26864e90a31c102e8763 Mon Sep 17 00:00:00 2001 From: eiymba <25769322+eiymba@users.noreply.github.com> Date: Sat, 5 Nov 2022 05:02:45 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20Add=20more=20instruc?= =?UTF-8?q?tions=20on=20developer=20environment?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Docs/BUILDING.md | 29 ++++++++++++----------------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/Docs/BUILDING.md b/Docs/BUILDING.md index 6a226a9..63c5929 100644 --- a/Docs/BUILDING.md +++ b/Docs/BUILDING.md @@ -1,28 +1,23 @@ # Building Arcadia -## Prerequisites +## Getting Started -- A text editor like [Visual Studio Code](https://code.visualstudio.com/). -- [Git](https://git-scm.com/). +The easiest way to get started is by connecting your Github account to Gitpod! ([What is Gitpod?](https://www.gitpod.io/)) + Contribute with Gitpod + -## Building +### Prerequisites -### Clone the repository +- [ ] You have a [GitHub account](https://github.com). +- [ ] You have [Git](https://git-scm.com/) installed on your machine. _(Don't want to install Git? Try [Gitpod](https://gitpod.io/#eiymba/arcadia))_ +- [ ] A text editor like [Visual Studio Code](https://code.visualstudio.com/) with [Lua](https://www.lua.org/) language support. _(Don't want to install anything? Try [Gitpod](https://gitpod.io/#eiymba/arcadia))_ -#### HTTPS (Simple) - -```bash -git clone --recursive-submodules https://github.com/eiymba/arcadia.git; cd arcadia -``` - -#### SSH (Advanced) - -```bash -git clone --recursive-submodules git@github.com:eiymba/arcadia.git; cd arcadia -``` -### Build the project +### Build The Project Arcadia comes with a build script that will build the project and package it into a `.zip` file. The script can also extract the `.zip` file into your WoW Addons directory, by passing the `-x` flag. -- 1.7.9.5