Merge branch 'main' of https://github.com/NiTrO0FuN/easy-e2

README.md

@@ -1,3 +1,58 @@
-# Tech used
 
-Vue3
+# Easy E2
+
+<img src="https://raw.githubusercontent.com/NiTrO0FuN/easy-e2/main/easy_e2.svg" width=100>
+
+E2 helper to easily create interactive EGPv3 screens.
+
+Automatically deployed on: https://nitro0fun.github.io/easy-e2/
+
+[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
+
+[![Build status](https://img.shields.io/github/actions/workflow/status/NiTrO0FuN/easy-e2/build.yml)](https://github.com/NiTrO0FuN/easy-e2/deployments)
+
+## Walkthrough
+### 1- Online
+- Go to the official [website](https://nitro0fun.github.io/easy-e2/).
+- Create up to 10 screens with at most 300 objects per screen.
+- Copy the generated E2 code on the right-hand side of the screen.
+### 2- In-game
+- Place an EGPv3 screen as well as an E2 chip.
+- Paste the code into the E2 chip (right click on the chip with the E2 toolgun to access it).
+- Connect the chip to the screen as follows:
+<img src="https://github.com/NiTrO0FuN/easy-e2/assets/128875940/93c4a985-11a0-4909-8869-dd3514ad16c3" width=200>
+
+- Enjoy!
+
+## Run Locally
+
+Clone the project
+
+```bash
+  git clone https://github.com/NiTrO0FuN/easy-e2
+```
+
+Go to the project directory
+
+```bash
+  cd easy-e2
+```
+
+Install dependencies
+
+```bash
+  npm install
+```
+
+Start the dev server
+
+```bash
+  npm run dev
+```
+
+
+## Tech Stack
+
+**Client:** [Vue.js](https://vuejs.org/), [Quasar](https://quasar.dev/), [Fabric.js](http://fabricjs.com/), [Highlightjs](https://highlightjs.org/)
+
+