aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJuan J. Martinez <jjm@usebox.net>2022-06-24 08:41:48 +0100
committerJuan J. Martinez <jjm@usebox.net>2022-06-24 08:41:48 +0100
commitd8990284057e6401d0374f439df51879595d804d (patch)
tree61e2bf9e832d28d7f83431ec5bb0725120451ee6
parent15a7f7e4bda1a022a9e871b6c57fa7a7be22eb74 (diff)
downloadubox-msx-lib-d8990284057e6401d0374f439df51879595d804d.tar.gz
ubox-msx-lib-d8990284057e6401d0374f439df51879595d804d.zip
Fixing some formatting issues in the docs
-rw-r--r--docs/mplayer.md2
-rw-r--r--docs/tools.md11
-rw-r--r--include/ap.h2
3 files changed, 8 insertions, 7 deletions
diff --git a/docs/mplayer.md b/docs/mplayer.md
index 15247f1..0edbd00 100644
--- a/docs/mplayer.md
+++ b/docs/mplayer.md
@@ -40,7 +40,7 @@ Notes on **Disark**:
This is automated, and the only counter-intuitive step is making an ASM file
for **rasm** such as:
-```
+```nasm
;
; to build the custom AKM player with song + effects
;
diff --git a/docs/tools.md b/docs/tools.md
index a1311b1..19705a7 100644
--- a/docs/tools.md
+++ b/docs/tools.md
@@ -45,9 +45,10 @@ identifier (if the default "tiles" is used, the table will use `tiles_colors`).
The colour table can be omitted using the `--no-colors` flag.
Example of use:
-```
+```bash
png2tiles.py tiles.png > tiles.h
```
+
This will result in a C include output. To generate assembler, use `--asm` flag.
The output can be used with [ubox_set_tiles](ubox-lib-ref.html#ubox_set_tiles) and
@@ -77,7 +78,7 @@ corresponding to the sprite defined by the green colour and the sprite
defined by the white colour.
Usage following the example:
-```
+```bash
png2sprites.py -i player_sprite player.png > player.h
```
@@ -143,7 +144,7 @@ Each of these rooms will have the following structure:
The output by default is a C include file.
For example:
-```
+```bash
map.py --aplib map.json rooms > rooms.h
```
@@ -153,7 +154,7 @@ rooms. In this case, the output is compressed with [aPLib](extra-lib-ref.html#ap
The include by default will not include the data if `LOCAL` is undefined. It
should be included as follows in **one** C module:
-```
+```C
/* in data.c for example */
#define LOCAL
#include "rooms.h"
@@ -210,7 +211,7 @@ It takes three parameters:
- the map file (output of SDCC)
For example:
-```
+```bash
chksize 8000 4000 game.map
```
diff --git a/include/ap.h b/include/ap.h
index 4875f88..a42e16d 100644
--- a/include/ap.h
+++ b/include/ap.h
@@ -14,7 +14,7 @@
// It will be compiled as part of the tools, but you can compile it
// independently with:
//
-// ```
+// ```bash
// make bin/apultra
// ```
//