From 7a68294a22f5bf76768c04414845ad78aabd8b61 Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Mon, 13 Mar 2023 23:08:32 +0800 Subject: [PATCH] Update README.md Signed-off-by: Kalila <69767640+digisomni@users.noreply.github.com> --- README.md | 48 +++++++++--------------------------------------- 1 file changed, 9 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 38d6030ddc7..04ddf42be74 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,6 @@ GitHub forks Apache 2.0 Discord -

-

Build Status

-

- Master CI Build -

### What is this? @@ -21,14 +16,15 @@ Vircadia™ is an open source metaverse project seeking to incrementally bring a * Full-body avatars * Script with JavaScript & TypeScript (coming soon) * Visual scripting (coming soon) -* Full world editor (coming soon) +* Full world editor * 4096km³ world space in a server * Fully self-hosted * Apache 2.0 +* And more... -### How to use +### Support -Coming soon... +If you need help integrating or deploying Vircadia for your company / organization, please [reach out](https://vircadia.com/#contact) to us. ### How to deploy a Server @@ -52,38 +48,12 @@ Coming soon... - [For Windows - Interface & Server](https://github.com/vircadia/vircadia/blob/master/INSTALLER.md) - [For Linux - Server .deb - Vircadia Builder](INSTALLER.md#ubuntu-1804--deb) -### Boot to Metaverse: [The Goal](https://vircadia.com/vision/) - -Having a place to experience adventure, a place to relax with calm breath, that's a world to live in. An ecosystem to support an infinite combination of worlds without censorship and interruption is "metaverse". Finding a way to make infinite realities our reality is the dream. - -### Boot to Metaverse: The Technicals - -Vircadia consists of many projects and codebases with its unifying structure's goal being a decentralized metaverse. - -- The Developer Interface & Client API (Codename Athena) - You are here! -- The Server (Codename Athena) - You are also here! -- [The Web Interface (Codename Aether)](https://github.com/vircadia/vircadia-web/) -- [The Web SDK (Codename Ananke)](https://github.com/vircadia/vircadia-web-sdk/) -- [The Unity SDK (Codename Ourea)](https://github.com/vircadia/vircadia-unity-sdk/) -- [The Metaverse Server (Codename Iamus)](https://github.com/vircadia/Iamus/) -- [The Metaverse Server Dashboard (Codename Iamus)](https://github.com/vircadia/project-iamus-dashboard/) - -#### Documentation -- [User Documentation](https://github.com/vircadia/vircadia-docs-sphinx/) -- [Developer Documentation](https://github.com/vircadia/vircadia-dev-docs/) - -### Contribution - -There are many contributors to Vircadia. Code writers, reviewers, testers, documentation writers, modelers, and general supporters of the project are all integral to its development and success towards its goals. Find out how you can [contribute](https://vircadia.com/contribute)! - -### Support - -You can support the Vircadia project financially through [GitHub Sponsors](https://github.com/sponsors/digisomni/). +### Architecture and Documentation -You can also support individual active contributors by visiting each repository, this is the main Vircadia repository's [list of active contributors](https://vircadia.com/contributors-redirector/?redirect=vircadia/vircadia). Click on a contributor's profile to see if they accept donations! +If you would like to learn more about the architecture and the various components in the ecosystem, visit the developer docs. -Keep in mind that Vircadia consists of multiple smaller projects that might have different active contributors. This is a [a non-exhaustive list](https://github.com/vircadia). +- [Developer Documentation](https://docs.vircadia.dev/) -#### Supporters of the Vircadia Project +### Supporters of the Vircadia Project -Vircadia is sponsored by many companies and organizations, some of which can be found [here](https://vircadia.com/#partners). +Vircadia is sponsored by companies, organizations, and governments, some of which can be found [here](https://vircadia.com/#partners).