Commit Graph

49 Commits

Author SHA1 Message Date
Léo Lam 1f833303f9
readme: fix Discord link 2025-06-14 03:36:10 +02:00
Léo Lam 1d7ce82908
Link to new documentation website 2022-10-19 15:44:44 +02:00
Denis LE a4e374e865
Improve README.md formatting (#97)
Just a small formatting edit to improve readability
2022-06-28 23:21:58 +02:00
Léo Lam 53bb59d73d
readme: Add clang and libssl-dev to dependency list
needed for the Rust tools
2022-02-07 18:20:13 +01:00
Anne e3ce9ec089 Update README.md to include xdelta 2022-01-27 16:50:29 -08:00
Léo Lam 1159f84e3c
contributing: Move Python module deps to readme 2021-12-09 14:15:41 +01:00
Léo Lam 70354f58fe
readme: Steal^H^H^H^H^Hborrow fancy badges from OoT 2021-12-03 00:41:08 +01:00
Léo Lam fdd2057f27
readme: Fix path to setup script 2021-09-06 15:52:16 +02:00
Léo Lam 203d8da309
readme: Explain why 1.6.0 is not being decompiled 2021-08-23 22:09:09 +02:00
Léo Lam 8812e80809
readme: Update reference to Contributing.md for 1.6.0->1.5.0 patch 2021-08-13 21:49:50 +02:00
Léo Lam df99eb76ba
readme: Reorder some paragraphs to make the intro flow better 2021-08-11 02:15:33 +02:00
MonsterDruide1 aa4231eff2 tools/setup: Auto-install `check` (viking) 2021-08-10 22:11:04 +02:00
MonsterDruide1 18152c5909 tools: Migrate to external repo 2021-08-10 22:11:03 +02:00
Léo Lam 80bf9236a3
Remove old tools/check.py
RIP check.py 2020-2021
2021-07-31 12:42:14 +02:00
Léo Lam 3fc83fd051
Streamline project setup by automating NSO conversion (if needed) 2021-07-23 12:40:49 +02:00
Léo Lam fc04f184c8
readme: Add note about cloning the repo in WSL 2021-07-23 00:10:54 +02:00
Léo Lam 5d7fa0aede
Simplify build setup by adding a setup script 2021-07-22 02:45:01 +02:00
Léo Lam 8cf3dd776b
build: Clean up build toolchain (and use musl for libc)
Using musl is required to match several functions that use <math.h>
floating point functions like isnan.

This also removes a dependency on devkitA64. We previously only needed
it because Clang insisted on using GCC to link the final executable
owing to the use of a "bare metal" target like aarch64-none-elf.
We can make Clang invoke the linker itself by using a Linux target.
2021-07-21 22:26:11 +02:00
Léo Lam 79505a1b23
readme: Clarify project scope (and excluded libraries) 2021-06-15 01:49:54 +02:00
Léo Lam 950db241d3
readme: Add note about accuracy of source code 2021-06-15 01:49:54 +02:00
Léo Lam 0c9821e7fb
readme: Add more resources (AArch64, tools) 2021-05-21 00:16:38 +02:00
Léo Lam 38ffb1f160
readme: Fix typo 2021-05-18 13:16:29 +02:00
Léo Lam 845fd2d139
readme: Add more frequently asked questions and reorder sections 2021-05-18 13:14:31 +02:00
Léo Lam 98ace1a751
readme: Remove outdated note about current focus of the project
Enough code has been decompiled in KingSystem that Game code can also
be decompiled now
2021-05-15 17:48:25 +02:00
Léo Lam 6850c0d169
readme: Add more FAQs 2021-03-31 14:11:46 +02:00
Léo Lam 5f575cd5ff
readme: Mention that ~ shouldn't be used in build command 2021-03-29 16:56:53 +02:00
Léo Lam 7fc889714e
readme/contributing.md: Reorder sections 2021-03-16 01:51:45 +01:00
Léo Lam 9e3975a813
readme: Clarify how progress is tracked 2021-02-19 13:53:15 +01:00
Léo Lam dbd3fbb3d2
readme: U-King -> BotW
leftover from the old repo
2021-02-19 12:59:11 +01:00
Léo Lam 0bb9f8ffde
readme: Fix heading levels 2021-01-23 23:02:27 +01:00
Léo Lam 3a0feebaab
Move contributing guidelines to a separate file
Keeps the readme short.
2021-01-23 11:20:30 +01:00
Léo Lam b128c71629
readme: Clarify that no proprietary SDK or leaks are used 2021-01-08 15:31:03 +01:00
Léo Lam 5912b65eff
uking/ui: Add Master Sword related inventory functions 2021-01-08 12:55:01 +01:00
Léo Lam 21cd25bcb4
Clarify project goal 2021-01-08 12:20:06 +01:00
Léo Lam 29abbdf4f1
readme: Explain how easy it is to match code 2020-12-10 23:40:12 +01:00
Léo Lam ecd1b9b486
Update readme information 2020-12-10 23:08:53 +01:00
Léo Lam da2a57992c
readme: Further clarify that this repo can't be used to play the game 2020-10-25 00:04:02 +02:00
Léo Lam 579b2c509d
readme: Explain that regalloc diffs are rare for truly equivalent code 2020-10-24 17:53:05 +02:00
Léo Lam 35ad671acf
readme: Mention the SHA256 hash of the 1.5.0 NSO 2020-10-19 20:32:24 +02:00
Léo Lam b648b9a877
readme: Mention tools/check.py 2020-10-15 00:58:12 +02:00
Léo Lam c5ef0a1fd3
readme: Add more information to the contributing section 2020-09-11 20:50:44 +02:00
Léo Lam e5f357dc6b
readme: Simplify setup and add more information and advice 2020-09-11 01:44:25 +02:00
Léo Lam 8398dad594
readme: Emphasize the fact that the project cannot be used for piracy 2020-08-30 16:37:20 +02:00
Léo Lam 880e1678e3
readme: Add information about the status of the project
And clarify that it cannot be used to play BotW, and that it does not
contain any copyrighted content from the RomFS.
2020-08-30 01:55:11 +02:00
Léo Lam 17701b157b
Bundle aarch64-none-elf-objdump 2.33 from Arm to simplify setup
Ubuntu 18.04's objdump is too old (2.30)

devkitA64's objdump is also too old (2.32) and doesn't support
--source-comment
2020-08-21 14:55:59 +02:00
Léo Lam cf50531807
readme: Add binutils-aarch64-linux-gnu to the list of dependencies 2020-08-21 12:30:15 +02:00
Léo Lam 26183142b1
Update instructions, fix diff settings and add asm-differ
...to simplify setup a bit
2020-08-21 12:16:06 +02:00
Léo Lam 86ca470778
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
2020-08-21 11:51:50 +02:00
Léo Lam 2de366be0f
Initial commit 2020-08-18 22:50:25 +02:00