https://github.com/blocksds/sdk
Main BlocksDS SDK repository
https://github.com/blocksds/sdk
homebrew nintendo-ds
Last synced: 3 months ago
JSON representation
Main BlocksDS SDK repository
- Host: GitHub
- URL: https://github.com/blocksds/sdk
- Owner: blocksds
- Created: 2023-02-18T17:49:56.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-07-03T22:53:04.000Z (3 months ago)
- Last Synced: 2025-07-03T23:01:58.478Z (3 months ago)
- Topics: homebrew, nintendo-ds
- Language: C
- Homepage: https://blocksds.skylyrac.net/
- Size: 11.1 MB
- Stars: 195
- Watchers: 12
- Forks: 15
- Open Issues: 42
-
Metadata Files:
- Readme: docs/readme.md
- License: licenses/cc0-1.0.txt
Awesome Lists containing this project
- awesome-dsdev - BlocksDS - a newer toolchain, maintained by AntonioND. (Software Development / Toolchains)
- awesome-blocksds - BlocksDS
README
# BlocksDS Documentation
The documentation of BlocksDS is built with [Hugo](https://gohugo.io). The theme
used is [Geekdoc](https://github.com/thegeeklab/hugo-geekdoc).
The documentation of the libraries included in BlocksDS is built with
[Doxygen](https://www.doxygen.nl).
## Prerequisites
- **Hugo**
Follow the [installation guide](https://gohugo.io/categories/installation/).
- **Geekdoc**
Install the theme by downloading [this tarball](https://github.com/thegeeklab/hugo-geekdoc/releases/latest/download/hugo-geekdoc.tar.gz)
and extracting it in `themes/hugo-geekdoc/`. For example, in Linux:
```bash
cd docs
wget https://github.com/thegeeklab/hugo-geekdoc/releases/latest/download/hugo-geekdoc.tar.gz | tar -xz -C themes/hugo-geekdoc/ --strip-components=1
```
## Testing the documentation of BlocksDS
If you have made some change to the documentation and want to check the output
locally, simply run the following command from the `docs` folder:
```bash
hugo server
```
That command will print a URL that you can open from a browser to see the
results.
You can also run the following command to only generate the static website
without a web server:
```bash
hugo
```
## Building documentation of libraries
Install Doxygen. Then, go to the root of each one of the libraries (`libnds`,
`dswifi`, etc) and run:
```bash
make docs
```
The output will be generated in the `docs/html` folder.
## Building and updating the combined documentation
The script `build-docs.sh` downloads the theme and builds the documentation of
all repositories of BlocksDS. Note that this sets the base URL of the
documentation to `https://blocksds.skylyrac.net/docs/`, so this script isn't
useful for non-maintainers. This script is used by the GitHub Actions workflow
of the following repository: https://github.com/blocksds/docs