Skip to content

Commit

Permalink
docs: update readme installation instructions (#259)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
cjmcassar authored Feb 9, 2024
1 parent 1643820 commit b042cf0
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 393 deletions.
18 changes: 5 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center" style="background-color: #CCCCCC;">
<a href="https://virocommunity.github.io/">
<img src="https://raw.githubusercontent.com/ViroCommunity/virocommunity.github.io/main/viro_community_logo.png" alt="Viro Community logo">
<a href="https://www.nativevision.xyz/">
<img src="../viro/public/icons/NVLogo.png">
</a>
</p>

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

# Examples

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.
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.

# Need help? Or want to contribute?

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

# A little history...

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.
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.

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.

# Supporters

<p align="center">
<a href="https://themorrow.digital/">
<img src="readmes/morrow-supporter.png" alt="Morrow">
</a>
</p>
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.
Binary file added public/icons/NVLogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
154 changes: 0 additions & 154 deletions readmes/EXAMPLES.md

This file was deleted.

13 changes: 0 additions & 13 deletions readmes/EXPO_PLUGIN.md

This file was deleted.

30 changes: 26 additions & 4 deletions readmes/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The steps below are for manually installing and linking the library to an existi

## Install

#### NPM
#### NPM

```console
$ npm install --save @viro-community/react-viro
Expand All @@ -18,13 +18,35 @@ $ npm install --save @viro-community/react-viro
$ yarn add @viro-community/react-viro
```

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

## OS Linking (You _must_ do this - we do not support auto-linking)

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.

## » [iOS linking](./INSTALL_IOS.md)
## » [iOS linking](https://viro-community.readme.io/docs/installation-instructions#ios-linking-you-must-do-this---we-do-not-yet-support-auto-linking)

## » [Android linking](https://viro-community.readme.io/docs/installation-instructions#android-linking-you-must-do-this---we-do-not-yet-support-auto-linking)

## Expo Plugin

## » [General Instructions](https://viro-community.readme.io/docs/integrating-with-expo#installation-instructions)

## » [Android Options](https://viro-community.readme.io/docs/integrating-with-expo#android-options)

## » [iOS Options](https://viro-community.readme.io/docs/integrating-with-expo#ios-options)

## » [Running your Expo app](https://viro-community.readme.io/docs/integrating-with-expo#running-your-expo-app)

## Examples

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!

## » [AR](https://viro-community.readme.io/docs/examples#ar-examples)

## » [VR](https://viro-community.readme.io/docs/examples#vr-examples)

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

# **Troubleshooting**

Expand Down
Loading

0 comments on commit b042cf0

Please sign in to comment.