Skip to content

Commit 6489233

Browse files
committed
Fix getting started documentation
1 parent 6a022e2 commit 6489233

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

docs/user-guide/Getting-Started-Guide.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,42 @@ After the install be sure to update the system software before proceeding.
2020
sudo apt update
2121
```
2222

23-
### Step 2: Download and extract the sources
23+
### Step 2: Get SceneScape sources
2424

2525
**Note:** These operations must be executed when logged in as a standard (non-root) user. **Do NOT use root or sudo.**
26+
#### Option 1: Download and extract the sources
2627

27-
1. Download the Intel® SceneScape software archive.
28-
Note the downloaded location (usually in the Downloads folder) and file name,
29-
which will be something like “scenescape_2024.1.tar.gz”
28+
1. Download the Intel® SceneScape software archive from https://github.com/open-edge-platform/scenescape/releases.
3029

31-
2. Extract the Intel® SceneScape archive on the target Ubuntu 22.04 system to the user home directory. Open a terminal, by default the current directory will be the user’s Home. Change directories to the Intel® SceneScape folder by typing the following at the command prompt.
32-
**Note:** [Tab] should autocomplete the directory name that was created from the extraction of the .tar.gz in the prior instructions.
30+
2. Extract the Intel® SceneScape archive on the target Ubuntu 22.04 system. Change directories to the extracted Intel® SceneScape folder.
3331
```bash
34-
cd scene[Tab]
32+
cd scenescape-<version>/
3533
```
3634

35+
#### Option 2: Clone the repository from GitHub
36+
37+
If you prefer to work directly with the source repository instead of downloading a release archive, follow these steps:
38+
39+
1. Install Git if it's not already installed:
40+
```bash
41+
sudo apt install git -y
42+
```
43+
44+
2. Clone the SceneScape repository:
45+
```bash
46+
git clone https://github.com/open-edge-platform/scenescape.git
47+
```
48+
49+
3. Change directories to the cloned repository:
50+
```bash
51+
cd scenescape/
52+
```
53+
54+
4. Check out the desired version tag (e.g., v1.3.0):
55+
```bash
56+
git checkout v1.3.0
57+
```
58+
3759
### Step 3: Build and deploy Intel® SceneScape to the target system
3860
3961
The deployment tool may take around 30 minutes to download and build the Intel® SceneScape container images. Do not disconnect the system from the network or close the terminal window during this process.

0 commit comments

Comments
 (0)