Skip to content

Commit 799d093

Browse files
committed
Improved documentation
Signed-off-by: Cédric Foellmi <cedric@onekiloparsec.dev>
1 parent 8e3e84f commit 799d093

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

docs/local/installation.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,11 @@ Before proceeding with the installation, ensure that you have the following prer
2323

2424
:::info
2525
The installation of Arcsecond requires you to write some simple commands in the Terminal. On *nix machines, you can use
26-
any shell. On Windows, you should use the bash terminal coming with the installation of
27-
the [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
26+
any shell. On Windows, with the installation of the [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) you
27+
have the possibility to install a small Linux distribution ("Distro"). Typically, with the Ubuntu Distro, you will have
28+
a bash shell. You may also stay with PowerShell if you wish of course.
29+
:::
30+
2831
:::
2932

3033
- Open the Terminal.
@@ -39,6 +42,11 @@ the [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
3942
- You can now start Arcsecond.local with the command: `docker compose up -d`. **The first time, Docker will download all
4043
the required images. It may take some time.**
4144

45+
::: warn
46+
By convention, the chevrons indicate placeholders in the documentation. Hence, you must also remove them when inserting
47+
your PAT. For instance: `echo ghp_XXX... | docker login...` and not `echo <ghp_XXX...> | docker login...`
48+
:::
49+
4250
## First steps
4351

4452
- Arcsecond.local is now accessible at the following address: [http://localhost:5555](http://localhost:5555)

0 commit comments

Comments
 (0)