rhaleblian/dslibris
1
Fork 0
mirror of https://github.com/rhaleblian/dslibris.git synced 2025-06-19 01:05:48 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Mention activating your shell

Browse Source
This commit is contained in:
Ray Haleblian 2022-09-24 09:32:02 -04:00
parent 6404bff7a5
commit f6ef4449bd
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -10,6 +10,7 @@ ebook reader for the Nintendo DS, DSi and DSi XL.
![A sample page](etc/sample/iliad.png) ![A sample page](etc/sample/iliad.png)
# Releases # Releases
See the Releases section for a program ready to be See the Releases section for a program ready to be
@ -18,39 +19,45 @@ patched and copied to your cartridge media.
The release file also contains a file structure for The release file also contains a file structure for
books and fonts that you should also copy. books and fonts that you should also copy.
# Installation # Installation
See INSTALL.txt or the See INSTALL.txt or the
[Quickstart](https://github.com/rhaleblian/dslibris/wiki/User:-Quickstart) [Quickstart](https://github.com/rhaleblian/dslibris/wiki/User:-Quickstart)
page in the Wiki. page in the Wiki.
# Development # Development
## Prerequisites ## Prerequisites
We use devkitPro's toolchain for ARM, aka `devkitARM`. We use devkitPro's toolchain for ARM, aka `devkitARM`.
Development is biased towards Ubuntu 20 as a platform. Development is biased towards Debian-clan (eg Ubuntu) as a platform.
You should also get far with macOS. You should also get far with macOS.
CentOS and msys2 have also worked, but haven't been checked recently. CentOS and msys2 have also worked, but haven't been checked recently.
Ubuntu under WSL would work too, but you'll be missing mount support Ubuntu under WSL would work too, but you'll be missing mount support
for emulator testing. for emulator testing.
The `bootstrap` script can speed up getting started. The `bootstrap` script can speed up getting started after cloning the repo.
Run it after cloning the repo.
Some configuration exists for using Visual Studio Code. Some configuration exists for using Visual Studio Code.
## Building ## Building
To build the program, To build the program, assure devkitARM is available to your shell:
```shell . activate
make
``` then
make
`dslibris.nds` should show up in the top directory. `dslibris.nds` should show up in the top directory.
See the Makefile for rules that apply DLDI for a few specific cases
(R4, CycloDS Evolution, MPCF).
## Debugging ## Debugging
`$DEVKITARM/bin/arm-none-eabi-gdb` and `DeSMuME`, `$DEVKITARM/bin/arm-none-eabi-gdb` and `DeSMuME`,
@ -65,3 +72,4 @@ See the `gdb` Make rule for a debugging process.
http://devkitpro.org http://devkitpro.org
http://idpf.org/epub http://idpf.org/epub