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

Minor doc improvements #2149

Merged
Changes from all 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
6 changes: 3 additions & 3 deletions documentation/builders/audio.md
Original file line number Diff line number Diff line change
@@ -13,14 +13,14 @@ Audio outputs run via PulseAudio and the basic configuration should be easy.
There is a [configuration tool](../developers/coreapps.md#run_configure_audio.py),
to setup the configuration for the Jukebox Core App.

To set up the audio
### To set up the audio

1. Follow the setup steps according to your sound card
2. Check that the sound output works [as described below](audio.md#checking-system-sound-output)
3. Run the the tool [run_configure_audio](../developers/coreapps.md#run_configure_audio.py)
4. [Fine-tune audio parameters](audio.md#additional-options)

## Checking system sound output
#### Checking system sound output

Run the following steps in a console:

@@ -53,7 +53,7 @@ volume level for this sink:
$ paplay -d sink_name /usr/share/sounds/alsa/Front_Center.wav
```

# Bluetooth
## Bluetooth

Bluetooth setup consists of three steps

8 changes: 5 additions & 3 deletions documentation/builders/installation.md
Original file line number Diff line number Diff line change
@@ -85,22 +85,24 @@ Run the following command in your SSH terminal and follow the instructions
cd; bash <(wget -qO- https://raw.githubusercontent.com/MiczFlor/RPi-Jukebox-RFID/future3/main/installation/install-jukebox.sh)
```
This will get the latest stable release from the branch future3/main.
This will get the latest **stable release** from the branch *future3/main*.
To install directly from a specific branch and/or a different repository
specify the variables like this:
```bash
cd; GIT_USER='MiczFlor' GIT_BRANCH='future3/develop' bash <(wget -qO- https://raw.githubusercontent.com/MiczFlor/RPi-Jukebox-RFID/future3/develop/installation/install-jukebox.sh)
```
This will switch directly to the specified feature branch during installation.
> [!NOTE]
> For all branches *except* the current Release, you will need to build the Web App locally on the Pi. This is not part of the installation process due to memory limitation issues. See [Steps to install](../developers/development-environment.md#steps-to-install)
> For all branches *except* the current Release future3/main, you will need to build the Web App locally on the Pi. This is not part of the installation process due to memory limitation issues. See [Developer steps to install](../developers/development-environment.md#steps-to-install)
If you suspect an error you can monitor the installation-process with
```bash
cd; tail -f INSTALL-<fullname>.log
```
After successful installation, continue with [configuring your Phoniebox](configuration.md).
4 changes: 2 additions & 2 deletions documentation/developers/pyhton.md
Original file line number Diff line number Diff line change
@@ -8,11 +8,11 @@
Before you can run Python code, you need to enable the virtual environment. On the Raspberry Pi, it's located in the project root `~/RPi-Jukebox-RFID/.venv`. Depending on your setup, the absolute path can vary.

```
$ ~/RPi-Jukebox-RFID/.venv/bin/activate
$ source ~/RPi-Jukebox-RFID/.venv/bin/activate
```

If the virtual environment has been activated correctly, your terminal will now show a prefix (`.venv`). If you want to leave the venv again execute deactivate.

```
$ ~/RPi-Jukebox-RFID/.venv/bin/deactivate
$ deactivate
```