README.md

🛸 ARSkyline

GitHub skyline viewer in augmented reality

🔍 Description

The goal of the project is to eventually be able to view any GitHub Skyline from their phone in augmented reality. In the future, it is possible to imagine many features such as the possibility of displaying a skyline on any flat surface, or even being able to read the GitHub pseudonym written on a surface to display the skyline on it.

The ARSkyline open source project powered by the Weemin company is therefore developed under Unity 2021.3.3f1 in C#.

⚙️ Installation

Follow the steps below to be able to install ARSkyline on your phone :
    1️⃣ Clone repository using git clone [email protected]:Weemin/ARSkyline.git
    2️⃣ Download and install the Unity editor version 2021.3.3f1
    3️⃣ Open the cloned project with Unity
    4️⃣ Switch platforms if necessary by going to File > Build Settings > Android > Switch platform in Unity
    5️⃣ Build project by going to File > Build Settings > Build in Unity
    6️⃣ Install on your device with the result

Once the first functional versions of the ARSkyline project will be available, it will be possible to download the compiled version directly.

📝 Usage

After installing the app on your device, just launch it. Depending on your configuration, you will have to accept the use of the camera.

📄 Support

If you have any questions or problems, you can create an issue or add a new discussion.

💡 Contributing

Do you have the slightest idea or do you want to develop the project? Feel free to contribute ! For this a contribution guide is available.