From 938e55f00b4b1305edcde892851d9362875e2396 Mon Sep 17 00:00:00 2001 From: Kieran Farr Date: Thu, 28 Dec 2023 10:30:02 -0800 Subject: [PATCH] Update README.md - add editor links - create links to documentation --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f3c1190f9..8a4f2bbde 100644 --- a/README.md +++ b/README.md @@ -8,21 +8,21 @@ ### Online Tool -|[Start 3DStreet](https://github.3dstreet.org/)| +|[Start 3DStreet](https://3dstreet.app/)| |---| -_(or visit https://github.3dstreet.org)_ +_(or visit https://3dstreet.app)_ + +### [Quick Start - How to make your own 3DStreet scene from Streetmix. See documentation here.](https://www.3dstreet.org/docs/category/tutorial-use-streetmix-to-create-a-3dstreet-scene) - +## The rest of this README is for developers. [User-facing docs are here.](https://www.3dstreet.org/docs/) -### Quick Start - How to make your own 3D street: -* First, use Streetmix.net to create a street design. (Streetmix is a tool that lets you design, remix, and share your neighborhood street. More information about Streetmix here.) -* Then, save a Streetmix street after making an account to generate a unique URL for your street looking something like this: `https://streetmix.net/kfarr/3/my-awesome-street-name` -* Load https://github.3dstreet.org/, paste in your street URL, and press enter or the refresh button. -* See your Streetmix street in 3D! See instant changes to your work: Switch back to a Streetmix.net tab, make changes to your street, then reload the 3DStreet page to see the edits applied. -* For more information, please see our [3DStreet and Streetmix Tutorial](/tutorials/3DStreet-streetmix-tutorial.md). +This repo is the 3DStreet Core Viewer. It provides parsing of JSON in Streetmix format into a 3DStreet scene. It also provides all of the core components needed for viewers. It is also a core dependency of the [3DStreet Editor hosted in a separate repository](https://github.com/3DStreet/3dstreet-editor). + +### Project Hosting Path +This repo's main branch is hosted via github pages at `github.3dstreet.org`. The 3DStreet Editor uses this path to fetch 3DStreet dependencies. A-Frame developers leveraging 3DStreet Core will also use this path. ## A-Frame component 3DStreet is built upon a custom A-Frame `street` component which is also available for you to customize for your own custom A-Frame street scenes. The `street` component takes a string of JSON and renders one or more "segments" (also known as lanes or slices) of a street and optionally buildings and ground to the left and right. @@ -34,11 +34,11 @@ _(or visit https://github.3dstreet.org)_ Street Component! - - + + - +