From 148d72e795264d39d3b49d1d429e252ff74f0e23 Mon Sep 17 00:00:00 2001
From: "Juan J. Martinez" <jjm@usebox.net>
Date: Thu, 24 Jun 2021 22:12:51 +0100
Subject: Documented chksize

---
 docs/tools.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/tools.md b/docs/tools.md
index 79c181d..83f80f3 100644
--- a/docs/tools.md
+++ b/docs/tools.md
@@ -200,7 +200,28 @@ Refer to the example game and `init_map_entities()` in `game.c` for a full examp
 
 ### chksize
 
-TODO
+This tool is used to calculate how much much space in the DATA and CODE
+sections is used by the game.
+
+It takes three parameters:
+
+- the CODE limit (in hexadecimal)
+- the DATA limit (in hexadecimal)
+- the map file (output of SDCC)
+
+For example:
+```
+chksize 8000 4000 game.map
+```
+
+Has the output:
+```
+ROM: 11430 bytes
+RAM: 01256 bytes
+```
+
+If the CODE (ROM) or the DATA (RAM) is over the provided limits, the tool will
+report it with an error.
 
 ### mkdeps.py
 
-- 
cgit v1.2.3