Skip to content
This repository was archived by the owner on Aug 18, 2024. It is now read-only.

doc: Simplify the installation instructions on the readme #2

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Ethereal Engine Basic

## Installation

1) Add Project to Ethereal Engine. All Ethereal Engine projects are mounted in the /packages/projects/projects sub-folder of Ethereal Engine. Using bash you could add this project using the following command:

```
cd etherealengine/packages/projects/projects
gh repo clone EtherealEngine/ee-tutorial-basic
cd ../../../
1) Add the project to Ethereal Engine
_All Ethereal Engine projects are mounted in the /packages/projects/projects sub-folder._
```bash
cd etherealengine
git clone https://github.com/EtherealEngine/ee-tutorial-basic packages/projects/projects/ee-tutorial-basic
```

2) Make sure you are in the root folder for Ethereal. Then run Ethereal Engine itself. There are several ways to do this. With a fresh repo from github you could do the following (from the Ethereal folder):

```
2) Run Ethereal Engine
```bash
npm install
npm run dev
```
You can now find the tutorial in the projects section of the studio at https://localhost:3000/studio


3) From the web admin panel of Ethereal Engine create a 'location' for the project. See https://localhost:3000/admin . Map the project to the name 'basic'.
### _Optional: Create a new 'location' for the scene_

4) Run the project on the web by visiting it with the URL you created. See https://localhost:3000/location/basic
3) Go to the web admin panel of Ethereal Engine at https://localhost:3000/admin/locations, and map the scene to the name 'basic'.
4) Run the project on the web by opening the URL you just created: https://localhost:3000/location/basic