summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDerek Hensley <hensley.derek58@gmail.com>2024-02-23 14:35:09 -0800
committerGitHub <noreply@github.com>2024-02-23 15:35:09 -0700
commita10bb11ed6784c6a16a09b7eb17657d2e1bb303c (patch)
treed56c420f49cb47b1aee7e4c4a9ca948041408f74 /README.md
parent84cb26a6b03cd5b886b2da4a5bc9eb881a05dda3 (diff)
Build Sync (#147)
* Makefile cleanup * venv * baseroms folder * Jenkinsfile * Remove z64compress * Small cleanup * More small fixes * diff_settings fix * Fix jenkins * make compress in readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 4 insertions, 17 deletions
diff --git a/README.md b/README.md
index 6a3119c..6404835 100644
--- a/README.md
+++ b/README.md
@@ -51,29 +51,15 @@ sudo apt install make git build-essential clang binutils-mips-linux-gnu python3
The build process has a few python packages required that are located in `requirements.txt`.
-It is recommend to setup a virtual environment for python to localize all dependencies. To create a virtual environment:
+To install them simply run in a terminal:
```bash
-python3 -m venv .venv
-```
-
-To start using the virtual environment on your current terminal run:
-
-```bash
-. .venv/bin/activate
-```
-
-Take in mind for each new terminal you'll need to **active** the Python virtual environment again. There's no need to create the virtual environment again.
-
-Now you can install the Python dependencies, to do so run:
-
-```bash
-python3 -m pip install -U -r requirements.txt
+make venv
```
#### 3. Prepare a base ROM
-Copy your ROM to inside the root of this new project directory, and rename the file of the baserom to reflect the version of ROM you are using. ex: `baserom.jp.z64`
+Copy your ROM to inside `baseroms/` in the version folder corresponding to your ROM's version, and rename the file of the baserom to `baserom.z64`. ex: `baseroms/jp/baserom.z64`
#### 4. Make and Build the ROM
@@ -84,6 +70,7 @@ make setup
make extract
make lib
make
+make compress
```
## Note about licensing