This repository was archived by the owner on Aug 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
doc: Simplify the installation instructions on the readme #2
Open
heysokam
wants to merge
3
commits into
main
Choose a base branch
from
doc-SimplifyReadme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|
||
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 'location' route for the project_ | ||
|
||
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, and map the project to the name 'basic'. | ||
DanielBelmes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
4) Run the project on the web by opening the URL you just created: https://localhost:3000/location/basic |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.