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

readme: Fix instructions 

* Fix the CMake minimum required version
* Add a note about using the official CMake APT repo to update CMake
  on Ubuntu
* Add a note about setting the PATH for devkitA64
* Mention CMake Tools for Visual Studio Code
This commit is contained in:
Léo Lam 2020-08-21 11:51:50 +02:00
parent 3ff4e8db65
commit 86ca470778
No known key found for this signature in database
GPG Key ID: 0DF30F9081000741
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -11,13 +11,17 @@ Currently, the focus is on decompiling AI classes and other small, mostly self-c
Building this project requires: Building this project requires:
- A C++17 capable compiler (or >= Clang 4.0) - A C++17 capable compiler (or >= Clang 4.0)
- CMake 3.10+ - Ninja (Ubuntu/Debian package: `ninja-build`)
- CMake 3.13+
If you are on Ubuntu 18.04, you can [update CMake by using the official CMake APT repository](https://apt.kitware.com/).
### Building a matching version for Switch ### Building a matching version for Switch
1. Download [Clang 4.0.1](https://releases.llvm.org/download.html#4.0.1) and extract the archive. 1. Download [Clang 4.0.1](https://releases.llvm.org/download.html#4.0.1) and extract the archive.
2. Set the UKING_CLANG environment variable to point to the extracted archive, such that `$UKING_CLANG/bin/clang` exists. 2. Set the UKING_CLANG environment variable to point to the extracted archive, such that `$UKING_CLANG/bin/clang` exists.
3. You'll also need devkitA64. Set the DEVKITA64 environment variable. For Linux, $DEVKITA64 is typically `/opt/devkitpro/devkitA64`. 3. You'll also need devkitA64. Set the DEVKITA64 environment variable. For Linux, $DEVKITA64 is typically `/opt/devkitpro/devkitA64`.
* Also add devkitA64 to your PATH: `export PATH=${DEVKITPRO}/devkitA64/bin:$PATH`
4. In the root of this repository, run: `mkdir build` 4. In the root of this repository, run: `mkdir build`
5. `cd build` 5. `cd build`
6. `cmake -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_TOOLCHAIN_FILE=../ToolchainNX64.cmake ..` 6. `cmake -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_TOOLCHAIN_FILE=../ToolchainNX64.cmake ..`
@ -25,6 +29,8 @@ Building this project requires:
On subsequent builds, just run `ninja -C build` from the project root. On subsequent builds, just run `ninja -C build` from the project root.
If you are using Visual Studio Code, installing the CMake Tools extension is recommended to make includes, compiler flags, etc. work automatically.
## Contributing ## Contributing
Using a decompiler such as Hex-Rays or Ghidra is strongly recommended. Using a decompiler such as Hex-Rays or Ghidra is strongly recommended.