Skip to content
This repository was archived by the owner on Sep 17, 2022. It is now read-only.

Commit 4b3761d

Browse files
Added better Readme
1 parent f7355e5 commit 4b3761d

File tree

4 files changed

+31
-20
lines changed

4 files changed

+31
-20
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,6 @@ crashlytics-build.properties
6868

6969
# Temporary auto-generated Android Assets
7070
/[Aa]ssets/[Ss]treamingAssets/aa.meta
71-
/[Aa]ssets/[Ss]treamingAssets/aa/*
71+
/[Aa]ssets/[Ss]treamingAssets/aa/*
72+
73+
ProjectSettings/*

Assets/Animations.meta

Lines changed: 0 additions & 8 deletions
This file was deleted.

Assets/Materials.meta

Lines changed: 0 additions & 8 deletions
This file was deleted.

README.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
1-
# Unity-App
2-
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
1+
# Welcome to ARgorithm Unity App!
2+
3+
This is the front-end of the project. This is where the magic of AR happens. The mobile app is an AR-Core application written with Unity Game Engine. It gives the user a platform to visualize the ARgorithms contributed by the programmers.
34

4-
Mobile Application to render data structures in augmented reality
55
For more info, check out [ARgorithm docs](https://argorithm.github.io/toolkit)
6+
7+
8+
# System Requirements for Contribution
9+
10+
- Windows 10 (64-bit)
11+
- Unity 2019.4.2xf version ([download Unity Hub](https://store.unity.com/download-nuo))
12+
- gradle-6.8.3 ([download](https://downloads.gradle-dn.com/distributions/gradle-6.8.3-all.zip))
13+
- ARCore XR Plugin (4.1.5+)
14+
- AR Foundation Plugin (4.1.5+)
15+
- TextMeshPro (2.1.4+)
16+
- Android ARCore compatible device.
17+
18+
19+
# Setting up the environment
20+
21+
[These](https://developers.google.com/ar/develop/unity/android-11-build) are the steps you **must** follow before building the project. The link for the gradle version compatible is already shared above.
22+
> **Note:** Please make sure the setup is exactly as prescribed in the link. Please start UnityHub or Unity as an administrator to avoid any possible build issues.
23+
24+
Other Unity package settings should automatically be installed once you clone the repository.
25+
26+
27+
# Releases
28+
Follow this [link](https://github.com/ARgorithm/Unity-App/releases) to download the current stable build of the application in .apk format.
29+
30+

0 commit comments

Comments
 (0)