From 0f94a59f164d0d9f2733db2ebfc796b091f4260b Mon Sep 17 00:00:00 2001
From: Markus Wellmann
Date: Thu, 30 Jan 2025 11:21:40 +0100
Subject: [PATCH] Update README.md (#283)
* Update README.md
- Added codefactor badge.
- Fixed underscore between badges
* Fixed Open UPM Link
* Fixed html formatting issue
* Removed Github Action pr_agent
* Fixed outdated links at below
* Added some more link descriptions
---------
Co-authored-by: poetter-sebastian <32681913+poetter-sebastian@users.noreply.github.com>
---
.github/workflows/pr_agent.yml | 26 --------------------------
README.md | 26 ++++++++++----------------
2 files changed, 10 insertions(+), 42 deletions(-)
delete mode 100644 .github/workflows/pr_agent.yml
diff --git a/.github/workflows/pr_agent.yml b/.github/workflows/pr_agent.yml
deleted file mode 100644
index 5fd1b2fe..00000000
--- a/.github/workflows/pr_agent.yml
+++ /dev/null
@@ -1,26 +0,0 @@
-on:
- pull_request:
- types: [opened, reopened, ready_for_review]
- issue_comment:
- types: [created]
-jobs:
- pr_agent_job:
- if: >
- github.event.sender.type != 'Bot' &&
- github.actor != 'github-actions'
- runs-on: ubuntu-latest
- permissions:
- issues: write
- pull-requests: write
- contents: write
- name: Run PR Agent on every pull request, respond to user comments
- steps:
- - name: PR Agent action step
- id: pragent
- uses: Codium-ai/pr-agent@main
- env:
- OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- github_action_config.auto_review: "false" # enable/disable auto review
- github_action_config.auto_describe: "false" # enable/disable auto describe
- github_action_config.auto_improve: "false" # enable/disable auto improve
diff --git a/README.md b/README.md
index 8c714207..ab00fd54 100644
--- a/README.md
+++ b/README.md
@@ -23,20 +23,14 @@
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
## Introduction
@@ -64,8 +58,8 @@ VR Builder is currently supported on Unity 6 or later. The default interaction s
VR Builder works out of the box with any headset compatible with Unity's XR Interaction Toolkit.
## Installation
-
-
+
+
Download the latest Unity package from [Releases](https://github.com/MindPort-GmbH/VR-Builder/releases). You can import the package in your Unity project by double clicking on it or dragging it in your Assets window.
@@ -77,7 +71,7 @@ Importing will take some time as VR Builder also imports the necessary dependenc
You can find comprehensive documentation in the [Documentation](/Documentation/vr-builder-manual.pdf) folder, or [online](documentation.mindport.co).
## Support Us
-
+
Our goal is to make VR Builder accessible for everyone - it is free and open source, and we want to keep things that way. To be able to maintain and extend it, we rely on your support!
@@ -104,4 +98,4 @@ Make sure to review VR Builder on the [Unity Asset Store](https://u3d.as/3pUD) i
If you have any issues, please contact [contact@mindport.co](mailto:contact@mindport.co). We'd love to get your feedback, both positive and constructive. By sharing your feedback you help us improve - thank you in advance!
Let's build something extraordinary!
-You can also visit our website at [mindport.co](https://www.mindport.co/).
+You can also visit our website at [MindPort.co](https://www.mindport.co/).