nytpu
/
tonc_template
mirror of https://github.com/nytpu/tonc_template.git
1
0
Fork 0
Code Issues Releases Wiki Activity

rework README

This commit is contained in:
nytpu 2021-07-29 12:44:41 -06:00
parent e883d8443f
commit 3b7ddba0c6
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -51,16 +51,21 @@ changed $`PROGNAME` in the `Makefile`)
Change the $`PROGNAME` macro in the `Makefile` to match your game's name. Then
simply add your code to `main.c` like you normally would. To add more C source
files, add them to the $`OBJS` macro in the `Makefile`. To add files to be
bundled with the ROM with GBFS, add the filename to the $`GBFSFILES` macro in
the `Makefile`.
files, add them to the $`OBJS` macro in the `Makefile`.
You can include `<tonc.h>` to get libtonc functions and `"gbfs.h"` to get GBFS
functions. Also included is a modified version of my own
[libmisc](https://git.sr.ht/~nytpu/libmisc) that provides some useful
In your source code, you can include `<tonc.h>` to get libtonc functions and
`"gbfs.h"` to get GBFS functions. Also included is a modified version of my
own [libmisc](https://git.sr.ht/~nytpu/libmisc) that provides some useful
functions; notably an arena allocator (`arena.h`) and string utilities
(`string_util.h`).
To use GBFS, first go [the `$(PROGNAME).gba` rule in the
Makefile](Makefile#L95-102) and follow the instructions in the comment to
enable GBFS. To add files to be bundled with the ROM with GBFS, add the
filename to the $`GBFSFILES` macro in the `Makefile`; if you want to include
images instead of already binary files, then add the files to the $`PNGFILES`
array instead.
## Contributing
@ -80,11 +85,12 @@ the Boost Software License in [`LICENSE`](LICENSE) or at
<https://www.boost.org/LICENSE_1_0.txt>.
This repository contains [libmisc](https://git.sr.ht/~nytpu/libmisc), which is
also licensed under the terms of the Boost Software License, version 1.0.
also Copyright (c) 2021 nytpu and is licensed under the terms of the Boost
Software License, version 1.0.
This repository contains [GBFS](https://pineight.com/gba/#gbfs). GBFS is
Copyright 2002 Damian Yerrick and is licensed under the terms of the MIT
license. See the [header of `gbfs.h`](gbfs.h#L4-24) for a full copy of the
license. See the [header of `gbfs.h`](gbfs.h#L4-24) for a full copy of the MIT
license.
All credit for [tonc](https://www.coranac.com/projects/tonc/) goes to cearn.