Skip to content

Commit

Permalink
update README files
Browse files Browse the repository at this point in the history
  • Loading branch information
kdoren committed Apr 12, 2021
1 parent 3e9ecb7 commit d854809
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 19 deletions.
21 changes: 11 additions & 10 deletions stage3/04-install-sw/files/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Jambox: Jamming with Raspberry Pi
Release 1.3.0b3
Release 1.3.0

## Changes from v1.2.0:
- **New Jamming Apps: JamTaba, QJackTrip**
Expand All @@ -11,6 +11,7 @@ Release 1.3.0b3
- Pi3 default setting has been changed to use PERIOD=128 (a bit more delay) to maximize audio quality.
- **System language can be changed**
- Pi menu -> Preferences -> Localization
- **Jamulus Server startup simplifed and placed on Desktop**
- **Bug fixes and performance improvements**

If you don't want to read the "Quickstart" section, scroll to the bottom to read "Other Topics".
Expand All @@ -30,7 +31,7 @@ If you don't want to read the "Quickstart" section, scroll to the bottom to read
- other 2-channel recording interfaces are likely to work
- other interfaces may require editing parameters in /etc/jackrdc.conf
- **Microphone and/or instrument** to USB Audio Interface
- Microphone preamp requires XLR cable (don't connect microphone to 1/4" jack)
- Microphone preamp requires XLR cable for best sound (don't connect microphone to 1/4" jack)
- Guitar/Bass to channel 2 (so channel 1 can be used for talkback)
- Keyboard can be wired as mono into channel 2, using channel 1 for talkback microphone.
- Stereo keyboard sounds best when using both channels (1/4" jacks)
Expand Down Expand Up @@ -103,14 +104,14 @@ If you don't want to read the "Quickstart" section, scroll to the bottom to read
### Wrap Up
- Jamulus and Sonobus each have a "Disconnect" button which will kill your connection.
- Closing the program ("x" in upper right) will exit the startup script.
- To shut the system down, double-click the "Power Off" button on the desktop, then wait 1 min for full shutdown.
- To shut the system down, double-click the "Power Off" button on the desktop, wait 1 min for full shutdown, then power off the Raspberry Pi.
- Try to avoid shutting down by simply killing power, it can corrupt the SD card and make system unbootable.
---
### Other Topics
+ **Getting & Giving Help**
- Questions: Start a Discussion or answer a question on github: [https://github.com/kdoren/jambox-pi-gen/discussions](https://github.com/kdoren/jambox-pi-gen/discussions)
- Bugs/Problems: Open an issue on GitHub: [https://github.com/kdoren/jambox-pi-gen/issues](https://github.com/kdoren/jambox-pi-gen/issues)
+ **Updating Jammming Apps (Jamulus - SonoBus - Jacktrip - Jamtrip - JamTaba)**
+ **Updating Jammming Apps (Jamulus - SonoBus - QJacktrip - JamTaba)**
- Jamming apps are installed as apt packages from repo.jambox-project.com, so can be easily updated.
- To update, double-click the "Update Apps" desktop icon.
+ **Updating Jambox**
Expand All @@ -122,12 +123,12 @@ If you don't want to read the "Quickstart" section, scroll to the bottom to read
+ **Running a Jamulus Server**
- Jamulus server can run on Raspberry Pi. It's best run on its own separate box. Running on the same Raspberry Pi that runs a Jamulus Client will increase jitter.
- Your internet connection needs enough upstream bandwidth to send streams to multiple clients. DSL and Cable internet typically don't have very much.
- You router will likely require port forwarding set up.
- Customizable Settings are described in file /home/pi/.config/Jamulus/jamulus-server.conf
- jamulus-server doesn't need the "jack" service, so stop it unless you're running a client: "sudo systemctl stop jack"
- To start: "sudo systemctl start jamulus-server"
- If you run a private server, your router will require port forwarding to be set up.
- Most customizable settings can be controlled from the Jamulus Server GUI, and are persistent.
- The NUMCHANNELS (default 10) and PORT (default 22124) settings are set in the file /home/pi/.config/Jamulus/jamulus-server.conf
- To start: Double-click the "Jamulus Server Start" desktop icon, or from command line: "sudo systemctl start jamulus-server"
- To auto-start jamulus-server at boot time: "sudo systemctl enable jamulus-server"
- If you want to enable session recording (experimental on Raspberry Pi), a USB3 SSD is recommended.
+ **Patch Changes**
- Please see the topic "How do I change patches" on GitHub: [https://github.com/kdoren/jambox-pi-gen/discussions](https://github.com/kdoren/jambox-pi-gen/discussions)
+ **JackTrip**
- There is another jamming app called JackTrip which is also installed. It's a command-line app for routing audio over a network, and by itself is not easy to use. Port forwarding setup on your router will likely be required. JackTrip can be used with the JamTrip wrapper, which simplifies JackTrip operation and configuration. You can report your experiences in the JackTrip discussion category on jambox-pi-gen GitHub.

19 changes: 10 additions & 9 deletions stage3/06-install-jamulus/files/jns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Jambox: Jamming with Raspberry Pi
## *Jazz Night School Edition*
Release 1.3.0b3
Release 1.3.0

## Changes from v1.2.0:
- **New Jamming Apps: JamTaba, QJackTrip**
Expand All @@ -14,6 +14,7 @@ Release 1.3.0b3
- Pi3 default setting has been changed to use PERIOD=128 (a bit more delay) to maximize audio quality.
- **System language can be changed**
- Pi menu -> Preferences -> Localization
- **Jamulus Server startup simplifed and placed on Desktop**
- **Bug fixes and performance improvements**

If you don't want to read the "Quickstart" section, scroll to the bottom to read "Other Topics".
Expand Down Expand Up @@ -117,14 +118,14 @@ If you don't want to read the "Quickstart" section, scroll to the bottom to read
### Wrap Up
- Jamulus and Sonobus each have a "Disconnect" button which will kill your connection.
- Closing the program ("x" in upper right) will exit the startup script.
- To shut the system down, double-click the "Power Off" button on the desktop, then wait 1 min for full shutdown.
- To shut the system down, double-click the "Power Off" button on the desktop, wait 1 min for full shutdown, then power off the Raspberry Pi.
- Try to avoid shutting down by simply killing power, it can corrupt the SD card and make system unbootable.
---
### Other Topics
+ **Getting & Giving Help**
- Questions: Start a Discussion or answer a question on github: [https://github.com/kdoren/jambox-pi-gen/discussions](https://github.com/kdoren/jambox-pi-gen/discussions)
- Bugs/Problems: Open an issue on GitHub: [https://github.com/kdoren/jambox-pi-gen/issues](https://github.com/kdoren/jambox-pi-gen/issues)
+ **Updating Jammming Apps (Jamulus - SonoBus - Jacktrip - Jamtrip - JamTaba)**
+ **Updating Jammming Apps (Jamulus - SonoBus - QJacktrip - JamTaba)**
- Jamming apps are installed as apt packages from repo.jambox-project.com, so can be easily updated.
- To update, double-click the "Update Apps" desktop icon.
+ **Updating Jambox**
Expand All @@ -136,14 +137,14 @@ If you don't want to read the "Quickstart" section, scroll to the bottom to read
+ **Running a Jamulus Server**
- Jamulus server can run on Raspberry Pi. It's best run on its own separate box. Running on the same Raspberry Pi that runs a Jamulus Client will increase jitter.
- Your internet connection needs enough upstream bandwidth to send streams to multiple clients. DSL and Cable internet typically don't have very much.
- You router will likely require port forwarding set up.
- Customizable Settings are described in file /home/pi/.config/Jamulus/jamulus-server.conf
- jamulus-server doesn't need the "jack" service, so stop it unless you're running a client: "sudo systemctl stop jack"
- To start: "sudo systemctl start jamulus-server"
- If you run a private server, your router will require port forwarding to be set up.
- Most customizable settings can be controlled from the Jamulus Server GUI, and are persistent.
- The NUMCHANNELS (default 10) and PORT (default 22124) settings are set in the file /home/pi/.config/Jamulus/jamulus-server.conf
- To start: Double-click the "Jamulus Server Start" desktop icon, or from command line: "sudo systemctl start jamulus-server"
- To auto-start jamulus-server at boot time: "sudo systemctl enable jamulus-server"
- If you want to enable session recording (experimental on Raspberry Pi), a USB3 SSD is recommended.
+ **Patch Changes**
- Please see the topic "How do I change patches" on GitHub: [https://github.com/kdoren/jambox-pi-gen/discussions](https://github.com/kdoren/jambox-pi-gen/discussions)
+ **JackTrip**
- There is another jamming app called JackTrip which is also installed. It's a command-line app for routing audio over a network, and by itself is not easy to use. Port forwarding setup on your router will likely be required. JackTrip can be used with the JamTrip wrapper, which simplifies JackTrip operation and configuration. You can report your experiences in the JackTrip discussion category on jambox-pi-gen GitHub.

#### Questions?
Contact: Kevin Doren *[email protected]*

0 comments on commit d854809

Please sign in to comment.