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

docs: update docs for new release #44

Merged
merged 2 commits into from
Dec 7, 2023
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
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,18 @@ The installation process is simple:
- **You must use the `obs-portable` launcher** to ensure OBS Studio finds all the associated libraries and add-ons.

```bash
wget "https://github.com/wimpysworld/obs-studio-portable/releases/download/r23319/obs-portable-30.0.0-r23319-ubuntu-$(lsb_release -rs).tar.bz2"
wget "https://github.com/wimpysworld/obs-studio-portable/releases/download/r23319/obs-portable-30.0.0-r23319-ubuntu-$(lsb_release -rs).tar.bz2.sha256"
sha256sum -c obs-portable-30.0.0-r23319-ubuntu-$(lsb_release -rs).tar.bz2.sha256
tar xvf obs-portable-30.0.0-r23319-ubuntu-$(lsb_release -rs).tar.bz2
cd obs-portable-30.0.0-r23319-ubuntu-$(lsb_release -rs)
wget "https://github.com/wimpysworld/obs-studio-portable/releases/download/r23341/obs-portable-30.0.0-r23341-ubuntu-$(lsb_release -rs).tar.bz2"
wget "https://github.com/wimpysworld/obs-studio-portable/releases/download/r23341/obs-portable-30.0.0-r23341-ubuntu-$(lsb_release -rs).tar.bz2.sha256"
sha256sum -c obs-portable-30.0.0-r23341-ubuntu-$(lsb_release -rs).tar.bz2.sha256
tar xvf obs-portable-30.0.0-r23341-ubuntu-$(lsb_release -rs).tar.bz2
cd obs-portable-30.0.0-r23341-ubuntu-$(lsb_release -rs)
sudo ./obs-dependencies
./obs-portable
```
### Upgrades

The upgrade process is the same as an install, and you can copy the `config` folder from your old OBS Studio Portable directory to the new one.
The upgrade process is the same as an install; download and extract the new tarball and run `sudo ./obs-dependenciesand` to ensure all the dependencies are installed.
Then copy the `config` folder from your old OBS Studio Portable directory to the new one.
If anything doesn't work correctly when you start the new OBS Studio, continue using the previous OBS Studio Portable instance.

## Distrobox (*any Linux*)
Expand Down Expand Up @@ -137,9 +138,9 @@ For example:
```bash
mkdir ~/OBS-Studio-again
cd ~/OBS-Studio-again
wget "https://github.com/wimpysworld/obs-studio-portable/releases/download/r23319/obs-portable-30.0.0-r23319-ubuntu-$(lsb_release -rs).tar.bz2"
tar xvf obs-portable-30.0.0-r23319-ubuntu-$(lsb_release -rs).tar.bz2
cd obs-portable-30.0.0-r23319-ubuntu-$(lsb_release -rs)
wget "https://github.com/wimpysworld/obs-studio-portable/releases/download/r23341/obs-portable-30.0.0-r23341-ubuntu-$(lsb_release -rs).tar.bz2"
tar xvf obs-portable-30.0.0-r23341-ubuntu-$(lsb_release -rs).tar.bz2
cd obs-portable-30.0.0-r23341-ubuntu-$(lsb_release -rs)
```

To launch the second instance of OBS Studio Portable in Distrobox, run the following command:
Expand Down Expand Up @@ -330,13 +331,13 @@ The actual build script, [`obs-build.sh`](builder/obs-build.sh), gets injected i

## Release numbers

An OBS Studio Portable for Linux release number will be something like r23319, and the filename will indicate the version of OBS Studio and which Ubuntu release it is for:
An OBS Studio Portable for Linux release number will be something like r23341, and the filename will indicate the version of OBS Studio and which Ubuntu release it is for:

```text
+-- OBS Portable for Ubuntu revision
|
v
obs-portable-30.0.0-r23319-ubuntu-22.04.tar.bz2
obs-portable-30.0.0-r23341-ubuntu-22.04.tar.bz2
^ ^
| |
+-- OBS version +-- Supported Ubuntu release
Expand Down