Skip to content

Update README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mihirm3hub wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 20 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,36 @@ DroidAR
DroidAR is a framework for Augmented Reality on Android. Location based AR and marker based AR are both possible.
Also read the [wiki articles](https://github.com/bitstars/droidar/wiki/_pages) (or the [FAQ](https://github.com/bitstars/droidar/wiki/FAQ)) for more detailed information about DroidAR.

This framework can be used for many different scenarios, there are already some demo applications available (check the videos below).
For the latest news about DroidAR also visit our [blog](http://droidar.blogspot.com/).
This framework can be used for many different scenarios; there are already some demo applications available (check the videos below).
For the latest news about DroidAR, also visit our [blog](http://droidar.blogspot.com/).

DroidAR is available under commercial license (contact us at "info (at) bitstars.com" for more details) and can be downloaded and used for non commercial use under the GNU GPL v3 ( http://www.gnu.org/licenses/gpl.html ) license.
DroidAR is available under a commercial license (contact us at "info (at) bitstars.com" for more details) and can be downloaded and used for non commercial use under the GNU GPL v3 ( http://www.gnu.org/licenses/gpl.html ) license.

[Register here to get notified for important news](https://docs.google.com/a/bitstars.com/forms/d/1l2AW1Qq16s2-MXpP_IRZ3GsVM6ZpDksCBUqGZNCNOy0)

If you want to you can support the opensource development of this project at [https://www.gittip.com/bitstars](https://www.gittip.com/bitstars)
If you want to, you can support the open-source development of this project at [https://www.gittip.com/bitstars](https://www.gittip.com/bitstars)

Tutorials
======

- http://parithi.com/?p=2183 (Thanks to ElamParithi Arul for writing it)
- https://www.youtube.com/watch?v=nK12gWQgItw (This video explains what needs to happen for Android studio to work, thanks Poseidonn77 for providing it)

- Thanks to ElamParithi Arul for writing the [tutorial](http://parithi.com/?p=2183)
- Thanks to Poseidonn77 for the Android Studio [tutorial](https://www.youtube.com/watch?v=nK12gWQgItw)

Contributing to the code
=======
I would be great if you want to help working on the code, fixing bugs, refactorings and adding you own ideas. Contributing to DroidAR is easy on GitHub (that's the main reason why we switched from Google Code).
It would be great if you want to help working on the code, fixing bugs, refactorings and adding you own ideas. Contributing to DroidAR is easy on GitHub (that's the main reason why we switched from Google Code).

1. Click "Fork", check out your fork and do your changes in your local copy of DroidAR
2. When you are done commit all changes to you online copy
2. When you are done, commit all changes to your online copy
3. Send a Pull-Request to via the Github webpage ([see Pull-Requests for more infos](https://help.github.com/articles/using-pull-requests)).
4. I will review your changes and merge them in the main repository so that everyone can use them.
4. I will review your changes and merge them into the main repository so that everyone can use them.

There are some rules to allow an easy integration of your code and changes:

- You have to use the default code formatting style of Eclipse
- You should enable auto formatting whenever you save a file. This way you can't forget to format: Go to Preferences->Java->Editor->Save Actions and enable "Format source code" and "Organize imports".
- You should enable auto-formatting whenever you save a file. This way you can't forget to format: Go to Preferences->Java->Editor->Save Actions and enable "Format source code" and "Organize imports".

Now when you save the code is formatted automatically. This will avoid commit conflicts and changes in the code can be reviewed more easily.
Now, when you save the code is formatted automatically. This will avoid commit conflicts, and changes in the code can be reviewed more easily.


Demo Videos
Expand Down Expand Up @@ -67,18 +66,18 @@ alt="Link to the DroidAR video" width="240" height="180" border="10" /></a>
Details
=======

Location based AR and marker based AR are both possible. This framework can be used for many different scenarios, there are already some demo applications available.
Location based AR and marker based AR are both possible. This framework can be used for many different scenarios; there are already some demo applications available.
- Footstep recognition & Indoor AR
- Locationbased Gaming & Crowdsourcing Framework
- Location-based Gaming & Crowdsourcing Framework

Since the initial creation of the prototype of an augmented reality development tool in 2010, it was continuously improved and new features were added. The created development tool (SDK) enables other programmers to integrate augmented reality in their own applications.
We provided the SDK without charge with an Open Source License for non-commercial projects. It has since evolved into one of the most used open source augmented reality SDKs for the Android platform. The regular feedback from the developers as well as its application in seminars and practical project seminars, where the SDK was used as basis for their projects, greatly aided its improvement. The framework meets and raises interests and is currently being used by numerous developers around the globe. The recorded numbers of the site are about 1500 website visits per month with an increasing tendency. Also, 83% of the about 3200 developers return to the website following their initial visit.
Since the initial creation of the prototype of an augmented reality development tool in 2010, it was continuously improved and new features were added. The created development tool (SDK) enables other programmers to integrate augmented reality into their own applications.
We provided the SDK without charge with an Open Source License for non-commercial projects. It has since evolved into one of the most used open source augmented reality SDKs for the Android platform. The regular feedback from the developers, as well as its application in seminars and practical project seminars, where the SDK was used as a basis for their projects, greatly aided its improvement. The framework meets and raises interests and is currently being used by numerous developers around the globe. The recorded numbers of the site are about 1500 website visits per month, with an increasing tendency. Also, 83% of the about 3200 developers return to the website following their initial visit.

Also take a look at the [DroidAR FAQ](https://github.com/bitstars/droidar/wiki/FAQ) and the other [Wiki pages](https://github.com/bitstars/droidar/wiki/_pages)

Installation
=======
A new instructions video is comming soon. You can watch the old one here:
A new instructions video is coming soon. You can watch the old one here:

<a href="http://www.youtube.com/watch?feature=player_embedded&v=MFbEvkWJOV0
" target="_blank"><img src="http://img.youtube.com/vi/MFbEvkWJOV0/0.jpg"
Expand All @@ -88,7 +87,7 @@ alt="Link to the DroidAR video" width="240" height="180" border="10" /></a>

Applications using DroidAR
=======
(If you use DroidAR in your application you can write us a mail to be added hiere)
(If you use DroidAR in your application, you can write us an email to be added here)

<a href="https://play.google.com/store/apps/details?id=com.thoughtshastra.templetreasure"
target="_blank"><img src="https://lh3.ggpht.com/6s2gdlZZPh80h7QvDc6JD7Y4nF3ap3EjrZ_pqrRKhho7XuJpcKBOC94mYN27M54jIXQS=h900-rw"
Expand All @@ -101,10 +100,10 @@ alt="CHIO Aachen" width="150" height="150" border="10" /></a>

DroidAR 2 (currently closed source)
=======
- DroidAR 2 has a plugin for the free to use and fully open source rendering engine jMonkey which allows rapid testing on the desktop and full customization for any application scenario
- DroidAR 2 has a plugin for the free-to-use and fully open-source rendering engine jMonkey, which allows rapid testing on the desktop and full customization for any application scenario
- The SDK combines sensor-based, location-based and SLAM tracking, everything offline on the phone
- Combinable detection techniques: Markers, 2d images, 3d objects, geolocations and gesture detection
- Strucutre from motion, 3D geometry reconstruction and texture projection
- Multiplayer components for adhoc network sessions between users and mixed AR+VR scenarios
- Structure from motion, 3D geometry reconstruction and texture projection
- Multiplayer components for ad hoc network sessions between users and mixed AR+VR scenarios

Contact us for more details