# A course on WEIDU - Appendix: guide to the WEIDU readme

By DavidW - V1.1 12/14/2023

- Introduction
- Chapter 1 (Introductory WEIDU)
- Chapter 2 (Programming in WEIDU)
- Chapter 3 (Specific WEIDU commands)
- Chapter 4 (More advanced topics)
- Appendix (the WEIDU readme)

WEIDU's readme is a very useful reference but fiddly to find your way around. Here's a quick guide to its contents.

### Readme features relevant to this course

- Section 9: formal specification of WEIDU's commands. This section is a vital reference.
- Section 10: WEIDU tutorials. Much of this has been covered in this coourse but you might find bits helpful.
- Section 12: Functions shipped with WEIDU. Another vital reference.
- Section 14: Formal specification of WEIDU regexps.
- Section 15: List of WEIDU constants (like DIALOG, NAME1, etc).
- Section 21: Index.

### The rest of the Readme

- Sections 1-2: obsolete
- Sections 3-4: Guide to the .d file and WEIDU's dialog management features. This is a completely different aspect of WEIDU from that covered in this course.
- Section 5: scripting. Ultra-brief, not-very-helpful reference on how WEIDU handles BCS files.
- Sections 6-7: Using WEIDU at the command line. Very helpful for power users, and again totally different from what this course covers.
- Section 8: tutorials on the dialog-management aspects of WEIDU.
- Section 11: obsolete.
- Section 13: Formal statement of how the conventions for WEIDU mod distribution work.
- Section 16: Brief, incomplete list of IE files formats. Obsolete (use IESDP).
- Sections 17-20: Comment on the source code; special thanks; copyright; note on undocumented features.