From f9be13bc09aaa61aba679eae76cdee7b9197b388 Mon Sep 17 00:00:00 2001 From: Kevin Beier Date: Thu, 8 Dec 2022 12:04:44 +0100 Subject: [PATCH 1/2] updated readme Signed-off-by: Kevin Beier --- README.md | 61 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 41 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 0ca446a..6fa3f70 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,41 @@ -# Introduction -TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project. - -# Getting Started -TODO: Guide users through getting your code up and running on their own system. In this section you can talk about: -1. Installation process -2. Software dependencies -3. Latest releases -4. API references - -# Build and Test -TODO: Describe and show how to build your code and run the tests. - -# Contribute -TODO: Explain how other users and developers can contribute to make your code better. - -If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files: -- [ASP.NET Core](https://github.com/aspnet/Home) -- [Visual Studio Code](https://github.com/Microsoft/vscode) -- [Chakra Core](https://github.com/Microsoft/ChakraCore) \ No newline at end of file +# Vigad + +## Description + +Welcome aboard fellow developers, this is an application where you are able to caputre areas on your screen and search for a specific value inside of it. With the generated data there are endless possibilities to use it for aswell as endless usecases for the applicaiton. + +## Requirements + +You need to have Node.js installed on your system. + +## How to Install and Run the Project + +Currently we do not have a release ready version of Vigad, but if you are interested to see what is happending you can install in locally onto you system. + +First of all you need to clone our repositiory. + +```sh +git clone https://github.com/VisualGameData/VIGAD.git +``` + +Afterwards you need to install the packages. + +```sh +npm i +``` + +Then there are two possibilities you can either start the application in developer mode via. + +```sh +npm run dev +``` + +Or if you would like to properly install the application as a programm onto your system you can write + +```sh +npm run build +``` + +and then execute the gerneated executable file (Windows) and you should be able to start the application and work with it. + +Keep in mind the build version may contain some problems we didn't fixed yet. From c54c716675121174cdd4475cb03543850f032dde Mon Sep 17 00:00:00 2001 From: Kevin Beier Date: Thu, 8 Dec 2022 14:26:24 +0100 Subject: [PATCH 2/2] fixed typos Signed-off-by: Kevin Beier --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6fa3f70..4f4564e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Description -Welcome aboard fellow developers, this is an application where you are able to caputre areas on your screen and search for a specific value inside of it. With the generated data there are endless possibilities to use it for aswell as endless usecases for the applicaiton. +Welcome aboard fellow developers, this is an application where you are able to capture areas on your screen and search for a specific value inside of it. With the generated data, there are endless possibilities to use it for, as well as endless use cases for the application. ## Requirements @@ -10,32 +10,32 @@ You need to have Node.js installed on your system. ## How to Install and Run the Project -Currently we do not have a release ready version of Vigad, but if you are interested to see what is happending you can install in locally onto you system. +Currently, we do not have a release ready version of Vigad, but if you are interested to see what is happening, you can install in locally onto your system. -First of all you need to clone our repositiory. +Foremost, you need to clone our repository. ```sh git clone https://github.com/VisualGameData/VIGAD.git ``` -Afterwards you need to install the packages. +Afterwards, you need to install the packages. ```sh npm i ``` -Then there are two possibilities you can either start the application in developer mode via. +Then there are two possibilities, you can either start the application in developer mode via. ```sh npm run dev ``` -Or if you would like to properly install the application as a programm onto your system you can write +Or if you would like to properly install the application as a program onto your system, you can write ```sh npm run build ``` -and then execute the gerneated executable file (Windows) and you should be able to start the application and work with it. +and then execute the generated executable file (Windows) and you should be able to start the application and work with it. -Keep in mind the build version may contain some problems we didn't fixed yet. +Keep in mind, the build version may contain some problems we didn't fix yet.