From bd812f7d928aa64f837e2fbd23e372ab65d03d87 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?John=20Ankarstr=C3=B6m?= <john@ankarstrom.se>
Date: Sat, 16 Jul 2022 02:04:01 +0200
Subject: README: Add information about Hungarian notation.

---
 README | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'README')

diff --git a/README b/README
index b4d27ed..8aeed8d 100644
--- a/README
+++ b/README
@@ -53,3 +53,23 @@ following additional programs are required:
 
 To build b/EpisodeBrowser.exe, issue `make' in the root directory of
 the project.
+
+Hacking
+~~~~~~~
+Like many Windows programs, Episode Browser uses Hungarian notation.
+Following is a list of prefixes commonly used in the code base:
+
+ lp	= pointer ("long/far pointer")
+ b	= boolean (BOOL, int)
+ i	= integer
+ siz	= size (size_t)
+ h	= handle
+ l	= long
+ w	= "word" (WPARAM)
+ dw	= "double word" (DWORD)
+ sz	= zero-terminated string (char *)
+ wsz	= ... wide string (wchar_t *)
+ tsz	= ... tstring (TCHAR *)
+ sm	= ... managed string (std::string)
+ wsm	= ... (std::wstring)
+ tsm	= ... (std::basic_string<TCHAR>)
-- 
cgit v1.2.3