Project-slippi/slippi-ssbm-asm
1
0
Fork 0
mirror of https://github.com/project-slippi/slippi-ssbm-asm.git synced 2025-10-05 15:42:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: update README with new build instructions (#101)

Browse Source
This commit is contained in:
Nikhil Narayana
2022-08-28 21:24:51 -07:00
committed by GitHub
parent a447b7c919
commit e530235246
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -6,8 +6,12 @@ This repository is part of the Project Slippi ecosystem. For more information ab
This project is home to the series of ASM mods that are applied to Melee in order to make Slippi work. It includes multiple configurations of the code for different use cases.
## Build Instructions
1. In order to build this project you will need to [download](https://github.com/JLaferri/gecko/releases) the `gecko` program and add it to your PATH env variable.
2. On windows you can then simply run the `build.bat` file to build all the different configurations. On mac/linux you can run the makefile or run `build.sh`.
### Local
1. In order to build this project you will need to [download](https://github.com/JLaferri/gecko/releases) the `gecko` program and add it to your PATH env variable. Linux/macOS users can pull the code and run `go build` to generate a binary.
2. All systems should support running `make` to build. Otherwise, on Windows you can run `build.bat` and on Linux/macOS you can run `build.sh`.
### Docker
We also have a docker image that you can use to build by running `docker run --volume=${PWD}:/work --workdir=/work nikhilnarayana/devkitpro-slippi make`.
## Output
### Console