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.

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

Cleanup build instructions #523

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

## Existing Image

Download current arcade Image from here (accessible to Thoth-Tech Team Members):
<https://deakin365.sharepoint.com/:u:/r/sites/ThothTech2/Shared%20Documents/SplashKit/Arcade%20Machine%20Image/ArcadeMachine.img?csf=1&web=1&e=7cuS7Z>
Download current arcade Image from here (accessible to Thoth-Tech Team Members): [here](https://deakin365.sharepoint.com/:u:/r/sites/ThothTech2/Shared%20Documents/SplashKit/Arcade%20Machine%20Image/ArcadeMachine.img?csf=1&web=1&e=7cuS7Z)

SHA256 Hash `31f0ea11c8492000d003108bf84afbb261ad6ee7c1be989f52a2b4add9d8821e`

Expand Down Expand Up @@ -111,7 +110,7 @@ and one to wpa_supplicant:

### 1. Install SplashKit

- Follow the instructions [here](https://splashkit.io/articles/installation/ubuntu/).
- Follow the instructions [here](https://splashkit.io/installation/linux/).
- Primarly perform steps 1 and 2, VS code is optional unless you whish to adjust programming on the
PI directly.

Expand All @@ -126,20 +125,28 @@ and one to wpa_supplicant:
curl -sSL https://dot.net/v1/dotnet-install.sh | bash /dev/stdin --channel STS
```

2. Add the following to the end of the file `~/.bashrc` with these commands
1. Add the following to the end of the file `~/.bashrc` with these commands

```shell
echo 'export DOTNET_ROOT=$HOME/.dotnet' >> ~/.bashrc
echo 'export PATH=$PATH:$HOME/.dotnet' >> ~/.bashrc
echo 'export DOTNET_ROOT=$HOME/.dotnet' >> ~/.bash.bash_profile

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be

Suggested change
echo 'export DOTNET_ROOT=$HOME/.dotnet' >> ~/.bash.bash_profile
echo 'export DOTNET_ROOT=$HOME/.dotnet' >> ~/.bash_profile

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Wills2022 Wondering about this too, just want to double check.

echo 'export PATH=$PATH:$HOME/.dotnet' >> ~/.bash_profile

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could source .bashrc from .bash_profile instead of duplicating export commands. If we do this, we must ensure that we don't make an infinite loop (.bash_profile sources .bashrc which sources .bash_profile...)

Not sure what's already in .bashrc - what do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would that cause weird behavior if the user configured their Arcade Machine with a desktop environment? or are you suggesting that we setup bashrc to clone its config directly from .bash_profile?

(I'm not exceptionally familiar with .bash_profile as I typically setup everything under my local .bashrc)

Copy link

@Liquidscroll Liquidscroll Aug 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that you just put in source ~/.bashrc and it gets executed when .bash_profile loads so you can kind of chain them.

My understanding is that .bash_profile loads when you use a non-root shell.

EDIT: I'll approve this without changing this and get the input of the next reviewer, but I'm thinking it might be best to keep the changes as they are now.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah it's a bit of a mess because history. Here's an excerpt from the bash man page

       ~/.bash_profile
              The personal initialization file, executed for login shells
       ~/.bashrc
              The individual per-interactive-shell startup file

So bash_profile is executed once when the user logs in (the definition of log in here is pretty vague so it ends up getting ran pretty frequently). bashrc is executed every time a new interactive session starts.

My recommendation would be to put the environment variable setting in bashrc. It shouldn't cause any weirdness with the desktop environment.

source ~/.bashrc
```

3. Verify the insalation with this command
1. Verify the installation with this command

```shell
dotnet --version
```

1. Create dotnet symbolic link. Replace `<VERSION>` with your dotnet version e.g. 7.0.5

```shell
ln -s ~/.splashkit/lib/linux/libsplashkit.so ~/.dotnet/shared/Microsoft.NetCore.App/<VERSION>/
```

### 3. Install Git

- Run the following command
Expand Down Expand Up @@ -183,7 +190,7 @@ and one to wpa_supplicant:
nano ~/.emulationstation/es_systems.cfg
```

8. Add the following to the file or downlaod a copy from
8. Add the following to the file or download a copy from
[here](/docs/Splashkit/Applications/Arcade%20Machines/Arcade%20Machine%20Setup/Files/es_systems.cfg)

```config
Expand Down Expand Up @@ -291,11 +298,11 @@ and one to wpa_supplicant:

3. Select Boot / Auto Login

![Rasberry Pi system Option Screen](/docs/Splashkit/Applications/Arcade%20Machines/Arcade%20Machine%20Setup/Images/BootAutoLogin.png)
![Rasberry Pi Boot Option Screen](/docs/Splashkit/Applications/Arcade%20Machines/Arcade%20Machine%20Setup/Images/BootAutoLogin.png)

4. Select Console Autologin

![Rasberry Pi Boot Option Screen](/docs/Splashkit/Applications/Arcade%20Machines/Arcade%20Machine%20Setup/Images/ConsoleAutoLogin.png)
![Rasberry Pi System Option Screen](/docs/Splashkit/Applications/Arcade%20Machines/Arcade%20Machine%20Setup/Images/ConsoleAutologin.png)

5. Return to main menu
6. Select Advanced Options
Expand Down
Loading