Skip to content
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

Update docs #217

Merged
merged 2 commits into from
Nov 23, 2024
Merged

Update docs #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a43e320
Update docs
thobson88 Nov 22, 2024
8f1596f
Update SHELL_CONFIG env variable creation in docs
thobson88 Nov 23, 2024
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
4 changes: 2 additions & 2 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Environment variables are defined in your Terminal configuration file. Since we

To do this, run the following command:
```console
$ echo "export SHELL_CONFIG=" $(find ~/.*shrc -maxdepth 0 | head -n 1) | sed 's/= /=/g' >> $(find ~/.*shrc -maxdepth 0 | head -n 1)
$ SHELL_CONFIG=$(find ~/.*shrc -maxdepth 0 | head -n 1) && echo "export SHELL_CONFIG=$SHELL_CONFIG" >> $SHELL_CONFIG
```
**Then close and reopen the Terminal window that you're working in**, so that the change takes effect. Now check that the new environment variable exists:
Now check that the new environment variable exists:
```console
$ echo $SHELL_CONFIG
```
Expand Down
12 changes: 6 additions & 6 deletions docs/ion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,17 +59,17 @@ In all cases, administrator privileges are required.

### Prerequisites

!!! info "Create the `SHELL_CONFIG` environment variable"

Before continuing, make sure you have created the `SHELL_CONFIG` environment variable by following the instructions on the [Getting Started](getting-started.md#environment-variables) page.

Run the following commands to set up your environment.

=== "Linux"

Update the package lists on your machine:
```console
$ sudo apt update
```
and install essential build tools:
Update the package lists on your machine and install essential build tools:
```console
$ sudo apt install build-essential
$ sudo apt update && sudo apt install build-essential
```
Install Git:
```console
Expand Down
Loading