-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2572f87
commit 5d42b6d
Showing
1 changed file
with
19 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,92 +1,32 @@ | ||
| # SafeARCross | ||
|
|
||
| SafeARCross is an AR application designed for the Microsoft HoloLens 2 aimed to improve awareness in pedestrian crossing scenarios using two systems, (1) a collision warning system, and (2) virtual traffic lights. Our analysis of this system showed that there was statistical evidence suggesting significant improvements in perceived workload, perceived safety, and a reduction in the number of head movements for these systems when compared to scenarios without AR assistance, concluding that the users trusted | ||
| the AR systems. Furthermore, participants rated the systems as excellent in terms of usability. | ||
|
|
||
| The Collision Warning System AR interface is designed to alert the user through a multi-modal warning system, that is activated when it receives a new DENM via MQTT, immediately alerting the user with: (1) a visual notification within the user’s center of view prompting to halt; (2) a 3D arrow pointing to the direction of the hazard; (3) and an 800 Hz tone lasting one second. As DENMs are continuously being transmitted during hazardous events, the visual alert remains active, only disappearing when a new message has not been received for more than one second. | ||
| <br> | ||
|
|
||
| ## Getting started | ||
| The project contains the binary .sln file ([SafeARCross.sln](https://github.com/nap-it/SafeARCross/blob/main/SafeARCross.sln)) ready to be deployed on the Microsoft HoloLens 2 using Visual Studio 2019. Follow the Microsoft [guidelines](https://learn.microsoft.com/en-us/windows/mixed-reality/develop/advanced-concepts/using-visual-studio?tabs=hl2) to deploy and debug using Visual Studio. | ||
| <br> | ||
|
|
||
| To make it easy for you to get started with GitLab, here's a list of recommended next steps. | ||
| ## Installation/Usage | ||
|
|
||
| Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! | ||
| To be able to compile this code first you must follow Microsoft's MRTK Unity [setup](https://learn.microsoft.com/en-us/training/modules/learn-mrtk-tutorials/1-3-exercise-configure-unity-for-windows-mixed-reality), clone the repository code and then follow the [build and deploy instructions](https://learn.microsoft.com/en-us/windows/mixed-reality/develop/unity/build-and-deploy-to-hololens). | ||
| <br> | ||
|
|
||
| ## Add your files | ||
|
|
||
| - [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files | ||
| - [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: | ||
|
|
||
| ``` | ||
| cd existing_repo | ||
| git remote add origin https://code.nap.av.it.pt/andreclerigo/safe-ar-cross.git | ||
| git branch -M main | ||
| git push -uf origin main | ||
| ``` | ||
|
|
||
| ## Integrate with your tools | ||
|
|
||
| - [ ] [Set up project integrations](https://code.nap.av.it.pt/andreclerigo/safe-ar-cross/-/settings/integrations) | ||
|
|
||
| ## Collaborate with your team | ||
|
|
||
| - [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) | ||
| - [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) | ||
| - [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) | ||
| - [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) | ||
| - [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) | ||
|
|
||
| ## Test and Deploy | ||
|
|
||
| Use the built-in continuous integration in GitLab. | ||
|
|
||
| - [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) | ||
| - [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) | ||
| - [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) | ||
| - [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) | ||
| - [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) | ||
|
|
||
| *** | ||
|
|
||
| # Editing this README | ||
|
|
||
| When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. | ||
|
|
||
| ## Suggestions for a good README | ||
| Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. | ||
|
|
||
| ## Name | ||
| Choose a self-explaining name for your project. | ||
|
|
||
| ## Description | ||
| Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. | ||
|
|
||
| ## Badges | ||
| On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. | ||
|
|
||
| ## Visuals | ||
| Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. | ||
|
|
||
| ## Installation | ||
| Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. | ||
|
|
||
| ## Usage | ||
| Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. | ||
|
|
||
| ## Support | ||
| Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. | ||
|
|
||
| ## Roadmap | ||
| If you have ideas for releases in the future, it is a good idea to list them in the README. | ||
|
|
||
| ## Contributing | ||
| State if you are open to contributions and what your requirements are for accepting them. | ||
|
|
||
| For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. | ||
|
|
||
| You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. | ||
| ## Dependencies | ||
| - [MRTK3](https://learn.microsoft.com/en-us/windows/mixed-reality/mrtk-unity/mrtk3-overview/): Framework used on the Microsoft HoloLens 2. | ||
| - [M2MqttUnity](https://github.com/CE-SDV/M2MqttUnity): This package is used to interact with MQTT messages (either publishing or subscribing). | ||
| - [UnityFigmaBridge](https://github.com/simonoliver/UnityFigmaBridge): This plugin was used to import the visual assets created for the Collision Warning System in Figma to the Unity Scene. | ||
| - [glTFast](https://github.com/atteneder/glTFast): This plugin was used to import the 3D arrow constructed in Blender (it .gltf format) to the Unity Scene. | ||
|
|
||
| ## Authors and acknowledgment | ||
| Show your appreciation to those who have contributed to the project. | ||
| This project is a collaborative effort with the following authors who have contributed to the development and success of this work: André Clérigo, Maximilian Schrapel, Pedro Teixeira, Pedro Rito, Susana Sargento, Alexey Vinel. | ||
|
|
||
| For any use of this code, data, or design, please refer to the [CITATION.cff](https://github.com/nap-it/SafeARCross/blob/main/CITATION.cff) file in the repository to properly acknowledge and cite the contributions of these authors. | ||
| <br> | ||
|
|
||
| ## License | ||
| For open source projects, say how it is licensed. | ||
| This project is licensed under the GNU General Public License v3.0. The full license can be viewed in the [LICENSE](https://github.com/nap-it/SafeARCross/blob/main/LICENSE) file included in this repository. | ||
|
|
||
| ## Project status | ||
| If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. |