Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 2.27 KB

README.md

File metadata and controls

69 lines (50 loc) · 2.27 KB

ARRuler

A simple iOS app which measures real-world distances using ARKit and Augmented Reality.

ARRuler allows you to measure distances using augmented reality. Shockingly, this app was developed before Apple added a measurement feature to the operating system. The code is written in a way in which any developer can easily follow, and if you'd like, you can contact me with any questions you might have :)

Installation

If you'd like to use ARRuler, you'll need to install it first. You can do so in one of two ways.

Terminal

To install the Xcode project using the command line, first enter your desired directory as follows:

cd /Desktop/Xcode_Projects/

And then, paste the following to install the project to your desired folder.

git clone https://github.com/vhanagwal/ARRuler.git

Github

Alternatively, you can download it via the "Clone or Download" button at the top right of the repository.

Contributing

This project is open source not only to share with the community, but to grow as well. I'd gladly welcome any contributions on this, or my other projects. To do so, follow the directions below.

1. Fork It

Use the following link to fork this repository:

https://github.com/vhanagwal/ARRuler/fork

2. Create Branch

Now, create a branch containing your newly added features with the following terminal command:

git checkout -b feature/fooBar

3. Commit Changes

Once you're done coding up the changes, commit them to the new branch you made.

git commit -am 'Add some fooBar'

4. Push

Then, to get the changes into GitHub, you can push them as follows:

git push origin feature/fooBar

5. Pull Request

Finally, create a new pull request to get my attention. It may take a few days for me to look at it, but make sure you format your comment like this:

Title: <create a descriptive title>
Date: <today's date>
Description: <a detailed description of what you did>

Meta

Vardhan Agrawal

Distributed under the BSD-3 Clause license. See LICENSE for more information.

https://github.com/vhanagwal