From ad6117404f94f2f69932f19f1b89233741ab5a4f Mon Sep 17 00:00:00 2001 From: Helloman892 <1565516+Helloman892@users.noreply.github.com> Date: Tue, 3 Apr 2018 23:48:47 +0100 Subject: [PATCH] updated readme to fit: dkP updates, buildtools updates, library changes, lexigraphical errors --- README.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ea23552..7fd7b34 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,21 @@ A Theme and Splashscreen Manager for the Nintendo 3DS, written in C.\ To-do list here: https://trello.com/b/F1YSa1VK # Dependencies - * zlib, jansson, and libarchive, which can be retrieved from the [3ds_portlibs](https://github.com/devkitPro/3ds_portlibs). + * devkitPro, which can be installed following the instructions [here](https://devkitpro.org/wiki/Getting_Started). + * zlib, jansson, and libarchive, which can be retrieved from [devkitPro pacman](https://devkitpro.org/viewtopic.php?f=13&t=8702). + * A recent build of [makerom](https://github.com/profi200/Project_CTR) and the latest release of [bannertool](https://github.com/Steveice10/bannertool). These must be added to your PATH. + A 64-bit Windows binary of makerom is available [here](https://hm892.s-ul.eu/U0Irkqih). + * ~~[pp2d](https://github.com/BernardoGiordano/pp2d), which is included in the repo if you do a git clone --recursive.~~ + Due to circumstances surrounding the privacy settings on the pp2d repo, the source files are now included directly within the repo. + * Git needs to be on your PATH (this is usually only manual under Windows). -* [makerom](https://github.com/profi200/Project_CTR) and [bannertool](https://github.com/Steveice10/buildtools), which can be retrieved from [SteveIce10's](https://github.com/Steveice10) buildtools repo. These must be added to your PATH. - * ~~[pp2d](https://github.com/BernardoGiordano/pp2d), which is included in the repo if you do a git clone --recursive.~~ Due to circumstances surrounding the privacy settings on the pp2d repo, the source files are now included directly within the repo. - * Git needs to be on your PATH, if building in a non-*nix environment. # Building -First of all, make sure devkitPRO is properly installed and added to the PATH. -After that, open the directory you want to clone the repo into, and type: `git clone https://github.com/astronautlevel2/Anemone3DS/ --recursive`. -Instructions for installing zlib, jansson and libarchive can be found on the [3ds_portlibs repo](https://github.com/devkitPro/3ds_portlibs) (its easy, just run `make` and `make install-zlib`). After also adding [makerom](https://github.com/profi200/Project_CTR) and [bannertool](https://github.com/Steveice10/buildtools) to your PATH, just enter your directory and run `make`. All built files will be in `/out/`. +First of all, make sure devkitPro is properly installed and added to your PATH. +After that, open the directory you want to clone the repo into, and execute +`git clone https://github.com/astronautlevel2/Anemone3DS` (or any other cloning method). +To install zlib, jansson and libarchive, begin by following the instructions found above ([here](https://devkitpro.org/viewtopic.php?f=13&t=8702)) on the devkitPro forums, and then install the dkP packages `3ds-zlib`, `3ds-jansson` and `3ds-libarchive`. +After also adding [makerom](https://github.com/profi200/Project_CTR) and [bannertool](https://github.com/Steveice10/buildtools) to your PATH, just enter your directory and run `make`. All built files will be in `/out/`. + # License This project is licensed under the GNU GPLv3. See LICENSE.md for details. Additional terms 7b and 7c apply to this project. @@ -22,13 +28,13 @@ The following people contributed to Anemone3DS in some way. Without these people * [LiquidFenrir](https://github.com/LiquidFenrir), who refactored a lot of my messy code and has been essential in development. * [Kenn (mattkenster)](https://github.com/mattkenster), for designing the GUI, a number of sprites used in the application, and drawing the banner and icon. -Special thanks go to these people who, while not directly contributing, helped immensely: +Special thanks go to these people who, whilst not directly contributing, helped immensely: * [Rinnegatamante](https://github.com/Rinnegatamante), whose code served as reference on theme installation. * [SteveIce10](https://github.com/SteveIce10), whose QR code in FBI was essential. * [BernardoGiordano](https://github.com/BernardoGiordano) for making pp2d, and being super responsive to feature requests and just general help. * [yellows8](https://github.com/yellows8) for his home menu extdump tool, which was invaluable in debugging. * the folks on #dev of Nintendo Homebrew, who helped with unicode shenanigans (especially [Stary2001](https://github.com/Stary2001), [Fenrir](https://github.com/FenrirWolf), and DanielKO). - * the maintainers for all used libraries, including ctrulib, zlib, citro3d, pp2d, quirc and minizip. + * the maintainers for all used libraries, including but not limited to ctrulib, zlib, citro3d, pp2d, and quirc. * all the people who helped keep me going and motivated me to work. This includes, but is definitely not limited to: + The members of the [Nintendo Homebrew Discord](https://discord.gg/C29hYvh)