You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: docs/osc.md
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,24 +71,32 @@ If you get a User Account Control pop-up that asks whether or not you would like
71
71
72
72
::: warning
73
73
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.
75
75
76
76
:::
77
77
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.
79
79
80
80

81
81
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
+

86
+
87
+
1. Run the command `source venv/bin/activate` to activate the virtual environment.
88
+
89
+

90
+
91
+
1. Run the command `pip install -r requirements.txt`. This will download Python packages needed to run OSCDL.
84
92
85
93

86
94
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.
88
96
89
97

90
98
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).
0 commit comments