falso
/
botw
mirror of https://github.com/zeldaret/botw.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

contributing: Move Python module deps to readme

This commit is contained in:
Léo Lam 2021-12-09 14:15:41 +01:00
parent b1a2f945cf
commit 1159f84e3c
No known key found for this signature in database
GPG Key ID: 0DF30F9081000741
2 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Contributing.md
View File

@ -1,10 +1,6 @@
# Contributing # Contributing
To contribute to the project, you will need: To contribute to the project, you will need a disassembler or a decompiler such as Hex-Rays or Ghidra.
* A disassembler or a decompiler such as Hex-Rays or Ghidra.
* Python 3 and pip for the diff script
* These Python modules: `capstone colorama cxxfilt pyelftools ansiwrap watchdog python-Levenshtein toml` (install them with `pip install ...`)
Experience with reverse engineering optimized C++ code is very useful but not necessary if you already know how to decompile C code. Experience with reverse engineering optimized C++ code is very useful but not necessary if you already know how to decompile C code.

4
README.md
View File

@ -156,7 +156,7 @@ The instructions below assume that you are using Linux (native or WSL) or macOS.
### 1. Set up dependencies ### 1. Set up dependencies
* Python 3.6 or newer * Python 3.6 or newer with [pip](https://pip.pypa.io/en/stable/installation/)
* Ninja * Ninja
* CMake 3.13+ * CMake 3.13+
* If you are on Ubuntu 18.04, you must first [update CMake by using the official CMake APT repository](https://apt.kitware.com/). * If you are on Ubuntu 18.04, you must first [update CMake by using the official CMake APT repository](https://apt.kitware.com/).
@ -172,6 +172,8 @@ Additionally, you'll also need:
* A Rust toolchain ([follow the instructions here](https://www.rust-lang.org/tools/install)) * A Rust toolchain ([follow the instructions here](https://www.rust-lang.org/tools/install))
* The following Python modules: `capstone colorama cxxfilt pyelftools ansiwrap watchdog python-Levenshtein toml` (install them with `pip install ...`)
### 2. Set up the project ### 2. Set up the project
1. Clone this repository. If you are using WSL, please clone the repo *inside* WSL, *not* on the Windows side (for performance reasons). 1. Clone this repository. If you are using WSL, please clone the repo *inside* WSL, *not* on the Windows side (for performance reasons).