Skip to content

Commit b042cf0

Browse files
authored
docs: update readme installation instructions (#259)
* update: made changes to logo link, history, and examples * feat: added logo file * update: included readme.io links to consolidate file * fix: depreciated old readme files
1 parent 1643820 commit b042cf0

File tree

8 files changed

+31
-393
lines changed

8 files changed

+31
-393
lines changed

README.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center" style="background-color: #CCCCCC;">
2-
<a href="https://virocommunity.github.io/">
3-
<img src="https://raw.githubusercontent.com/ViroCommunity/virocommunity.github.io/main/viro_community_logo.png" alt="Viro Community logo">
2+
<a href="https://www.nativevision.xyz/">
3+
<img src="../viro/public/icons/NVLogo.png">
44
</a>
55
</p>
66

@@ -41,7 +41,7 @@ The documentation is found [here](https://viro-community.readme.io/docs/overview
4141

4242
# Examples
4343

44-
See our [Example projects](readmes/EXAMPLES.md) page. These are a little old (~2019) but are a great reference point for how to use bits of the library.
44+
See our [Example projects](https://viro-community.readme.io/docs/examples) page. These are a little old (~2019) but are a great reference point for how to use bits of the library.
4545

4646
# Need help? Or want to contribute?
4747

@@ -51,14 +51,6 @@ See our [Example projects](readmes/EXAMPLES.md) page. These are a little old (~2
5151

5252
# A little history...
5353

54-
ViroReact was originaly developed by the [Viro Media](http://www.viromedia.com/) company, but was open sourced in 2019. In late 2020 the [Viro Community](https://virocommunity.github.io/) was formed to help maintain and move the project onwards, updating it so it could run with modern versions of react native, and start to add in new features.
54+
ViroReact was originaly developed by the [Viro Media](http://www.viromedia.com/) company, but was open sourced in 2019. In late 2020 the Viro Community was formed to help maintain and move the project onwards, updating it so it could run with modern versions of react native, and start to add in new features. NativeVision now focuses on the project full time making sure the codebase is updated and ready for the future of XR / Spatial Computing.
5555

56-
We, as a community, owe a great debt to Viro Media and the people who developed this library originally. We hope to make them proud as it continues to develop and grow in the Viro Community.
57-
58-
# Supporters
59-
60-
<p align="center">
61-
<a href="https://themorrow.digital/">
62-
<img src="readmes/morrow-supporter.png" alt="Morrow">
63-
</a>
64-
</p>
56+
We, as a community, owe a great debt to Viro Media and the people who developed this library originally. We hope to make them proud as it continues to develop and grow in the spirit of open source.

public/icons/NVLogo.png

26.7 KB
Loading

readmes/EXAMPLES.md

Lines changed: 0 additions & 154 deletions
This file was deleted.

readmes/EXPO_PLUGIN.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

readmes/INSTALL.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The steps below are for manually installing and linking the library to an existi
66

77
## Install
88

9-
#### NPM
9+
#### NPM
1010

1111
```console
1212
$ npm install --save @viro-community/react-viro
@@ -18,13 +18,35 @@ $ npm install --save @viro-community/react-viro
1818
$ yarn add @viro-community/react-viro
1919
```
2020

21-
## Linking (You _must_ do this - we do not support auto-linking)
21+
## » [General Instructions](https://viro-community.readme.io/docs/installation-instructions#installation-instructions)
22+
23+
## OS Linking (You _must_ do this - we do not support auto-linking)
2224

2325
If you're unsure about which file to edit or where to put specified the lines, we have added links to how this is done in our [starter-kit](https://github.com/ViroCommunity/starter-kit) repo.
2426

25-
## » [iOS linking](./INSTALL_IOS.md)
27+
## » [iOS linking](https://viro-community.readme.io/docs/installation-instructions#ios-linking-you-must-do-this---we-do-not-yet-support-auto-linking)
28+
29+
## » [Android linking](https://viro-community.readme.io/docs/installation-instructions#android-linking-you-must-do-this---we-do-not-yet-support-auto-linking)
30+
31+
## Expo Plugin
32+
33+
## » [General Instructions](https://viro-community.readme.io/docs/integrating-with-expo#installation-instructions)
34+
35+
## » [Android Options](https://viro-community.readme.io/docs/integrating-with-expo#android-options)
36+
37+
## » [iOS Options](https://viro-community.readme.io/docs/integrating-with-expo#ios-options)
38+
39+
## » [Running your Expo app](https://viro-community.readme.io/docs/integrating-with-expo#running-your-expo-app)
40+
41+
## Examples
42+
43+
Please note that these examples are a bit old, the code targets an older version of viro before the NativeVision took over the project. They will be updated soon!
44+
45+
## » [AR](https://viro-community.readme.io/docs/examples#ar-examples)
46+
47+
## » [VR](https://viro-community.readme.io/docs/examples#vr-examples)
2648

27-
## » [Android linking](./INSTALL_ANDROID.md)
49+
## » [Tutorials](https://viro-community.readme.io/docs/examples#tutorials)
2850

2951
# **Troubleshooting**
3052

0 commit comments

Comments
 (0)