pmret/papermario
1
0
Fork 0
mirror of https://github.com/pmret/papermario.git synced 2024-11-09 20:42:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #64 from nanaian/wsl-typos

Browse Source 
move windows_terminal.bat instructions to 'Contributing' section
This commit is contained in:
Ethan Roseman 2020-10-13 14:53:17 -04:00 committed by GitHub
commit 54c969341f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -8,10 +8,9 @@ Discord: [Paper Mario Modding](https://discord.gg/urUm3VG)
## Setup
You'll need Linux, a Linux VM, or Windows 10 (WSL) to work on this project. For WSL, we've included `windows_termainl.bat` under tools that you can use to quickly spin up a terminal for your default distro set using `wsl --set-default <Distro>`.
You'll need Linux, a Linux VM, or [Windows 10 (WSL2)](#wsl) to work on this project.
#### Clone the repository
```sh
$ git clone https://github.com/ethteck/papermario.git
$ cd papermario
@ -49,6 +48,10 @@ If you get `OK`, you're all set! Otherwise, please feel free to reach out to us
There are a few additional dependencies needed when contributing to this project. You can install them with `./install.sh --extra`.
### WSL
We provide [windows_terminal.bat](tools/windows_terminal.bat) to open a [Windows Terminal](https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701) with a recommended layout. Make sure a default distro (e.g. `wsl --set-default ubuntu`) is set beforehand.
### Rebuilding
Setting the `PM_HEADER_REBUILD` environment variable will cause `make` to rebuild all `.c` files whenever a `.h` file is modified.

1
tools/windows_terminal.bat
View File

@ -1,3 +1,2 @@
REM first set your default distro using: wsl --set-default <Distro>
ehco "first set your default distro using: wsl --set-default <Distro>"
wt --title "diff.py" -d "../" ; split-pane -d "../" -V ; new-tab --title "mips_to_c.py" -d "../" ; focus-tab -t 0