Skip to content

Commit 2a61767

Browse files
authored
Modify Linux/MacOS installation instructions for OSC to use a virtual environment (#180)
* Change instructions to create virtual environment * Change warning to notify about VENV * Rename image to resolve missing file issue * Modify img link to reflect filename change (oops) * Specify alias differences for Python on Linux
1 parent ab3b058 commit 2a61767

File tree

6 files changed

+14
-6
lines changed

6 files changed

+14
-6
lines changed

docs/osc.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,24 +71,32 @@ If you get a User Account Control pop-up that asks whether or not you would like
7171

7272
::: warning
7373

74-
You will need Python 3 installed in order to use OSCDL on these platforms.
74+
You will need Python 3 installed in order to use OSCDL on these platforms. Please note that on certain distros, Python 3 may use either `python` or `python3` as an alias, please be aware of this for Step 6. You will also create a virtual environment to isolate OSCDL and its dependencies from your base Python installation.
7575

7676
:::
7777

78-
1. Download the source code for OSCDL, either the `.zip` or the `.tar.gz`.
78+
1. Download the source code for OSCDL, either the `.zip` or the `.tar.gz`. Optionally, you can instead run `git clone https://github.com/dhtdht020/osc-dl.git` in the directory you would like to use OSCDL in.
7979

8080
![](/images/osc/source-code-download-OSCDL.png)
8181

82-
1. Extract the archive to a location on your computer that you would like to use OSCDL in.
83-
1. Open the location of the extracted files in a terminal and run the command `pip install -r requirements.txt`. This will download Python packages needed to run OSCDL.
82+
1. If you chose to download the source code, extract the archive to a location on your computer that you would like to use OSCDL in.
83+
1. Open the location of the extracted files in a terminal and run the command `python3 -m venv venv` to create a virtual environment. Note that, if you receive a message that `ensurepip` is not available, you must install the `python3-venv` package for your distribution. Python may provide a command for you to use to accomplish this.
84+
85+
![](/images/osc/create-virtual-environment.png)
86+
87+
1. Run the command `source venv/bin/activate` to activate the virtual environment.
88+
89+
![](/images/osc/activate-virtual-environment.png)
90+
91+
1. Run the command `pip install -r requirements.txt`. This will download Python packages needed to run OSCDL.
8492

8593
![](/images/osc/satisfy-requirements-OSCDL.png)
8694

87-
1. Run the command `python3 oscdl.py`. This will open the program. Optionally, you can also create a desktop shortcut that runs this command for easier access.
95+
1. Run the command `python3 oscdl.py`. This will open the program. If you choose to keep the terminal open, you can use `deactivate` to exit the virtual environment. Additionally note that you must run `source venv/bin/activate` in the directory where OSCDL was extracted every time you open a new terminal. This is in order to load the dependencies needed to run OSCDL.
8896

8997
![](/images/osc/run-OSCDL-terminal.png)
9098

91-
1. Find an application that you would like to get, and press the Download button. Alternatively, you can send the app directly to your Wii (this requires that your computer and Wii be on the same network).
99+
1. Once OSCDL is open, find an application that you would like to get, and press the Download button. Alternatively, you can send the app directly to your Wii (this requires that your computer and Wii be on the same network).
92100

93101
![](/images/osc/app-download-OSCDL-linux.png)
94102

18.4 KB
Loading
18.2 KB
Loading
-3.34 KB
Loading
-4.94 KB
Loading
-4.94 KB
Loading

0 commit comments

Comments
 (0)