Skip to content

Fix incorrect container paths in docs #1206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Rainyan merged 2 commits into from
Jul 15, 2025
Merged

Fix incorrect container paths in docs #1206

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eecbae6
Update linux sources info
Rainyan Jul 6, 2025
d896036
Fix container paths
Rainyan Jul 6, 2025
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
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,12 @@ Make sure the "x64 Native Tools Command Prompt for VS2022" is used instead of th
Your system must include the following packages:
`gcc g++ cmake ninja-build docker-ce docker-ce-cli containerd.io apt-transport-https ca-certificates curl gnupg gnupg-utils cmake build-essential`

**Note:** Depending on your operating system, the package names may vary, please consult google or your package manager for correct package names. The listed are for debian `apt`. (Includes Ubuntu, Linux Mint, etc)
> [!NOTE]
> Depending on your distro, the package names may vary; please consult Google or your package manager for correct package names. The listed are for Debian `apt`. (Includes Ubuntu, Linux Mint, etc).
>
> If using Docker, also note that following the [official install guide](https://docs.docker.com/desktop/setup/install/linux/) steps will likely configure sources for all transitive dependencies like
> `containerd.io`, so if they were not previously available by your package manager sources, it's worth checking again after installing Docker, before proceeding to add/install them manually. This is
> the case at least for APT.

Download and use the OCI image for Docker/Podman/Toolbx:

Expand All @@ -60,20 +65,20 @@ Download and use the OCI image for Docker/Podman/Toolbx:
###### Running the container
Docker:
```
# docker run -v /PATH_TO_REPO/neo/src:/root/neo/src --rm -it --entrypoint /bin/bash registry.gitlab.steamos.cloud/steamrt/sniper/sdk
# docker run -v /PATH_TO_REPO/:/root/neo/ --rm -it --entrypoint /bin/bash registry.gitlab.steamos.cloud/steamrt/sniper/sdk
$ cd /root/neo/src/
```

Podman:
```
$ podman run -v /PATH_TO_REPO/neo/src:/root/neo/src --rm -it --entrypoint /bin/bash registry.gitlab.steamos.cloud/steamrt/sniper/sdk
$ podman run -v /PATH_TO_REPO/:/root/neo/ --rm -it --entrypoint /bin/bash registry.gitlab.steamos.cloud/steamrt/sniper/sdk
$ cd /root/neo/src/
```

Toolbx:
```
$ toolbox enter sniper
$ cd /PATH_TO_REPO/neo/src
$ cd /PATH_TO_REPO/src
```

Depending on the terminal, you may need to install an additional terminfo in the container just to make it usable.
Expand Down