Skip to content

Commit 7fd19b0

Browse files
Add README for bin/ dir
1 parent fe9cbf3 commit 7fd19b0

File tree

2 files changed

+80
-250
lines changed

2 files changed

+80
-250
lines changed

bin/README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Executable scripts, for builds or development
2+
3+
## Building/Packaging/Installation
4+
5+
* [bumpver](bumpver)
6+
* Bumps the version e.g. from alpha2 to alpha3.
7+
* [defopt](defopt)
8+
* Adds a default configuration file to a disk image.
9+
* [install](install)
10+
* Installs a build to a disk image.
11+
* [lkg](lkg)
12+
* Builds a "last known good" package for the web site.
13+
* [manifest](manifest)
14+
* Outputs a list of files. Used by `package`, `install`, etc.
15+
* [mount](mount)
16+
* Installs a build to a directory, for use with Virtual ][.
17+
* [package](package)
18+
* Generates a set of disk images for distribution.
19+
* [roll](roll)
20+
* Updates external dependencies.
21+
* [setdate](setdate)
22+
* Updates the config with the current date.
23+
* [setlang](setlang)
24+
* Updates the config to build the specified language.
25+
* [setopt](setopt)
26+
* Updates the configuration file in a disk image.
27+
* [shk](shk)
28+
* Generates a ShrinkIt! archive for distribution.
29+
* [targets.pl](targets.pl)
30+
* Parses the `desk.acc/TARGETS` file, generates requested lists.
31+
32+
## Internationalization/Localization
33+
34+
* [Transcode.pm](Transcode.pm)
35+
* Perl library implementing 7-bit encoders/decoders, for localized builds.
36+
* [loc_makeres.pl](loc_makeres.pl)
37+
* Builds "res" files from a CSV copy of the master localization spreadsheet.
38+
* [transcode.pl](transcode.pl)
39+
* Utility for doing encoding/decoding of strings, for localized builds.
40+
41+
## Fonts
42+
43+
* [build_font_from_unicode_txt.pl](build_font_from_unicode_txt.pl)
44+
* Converts a text representation of a font to an MGTK font, for a given encoding.
45+
* [bw_font.pl](bw_font.pl)
46+
* Dumps a BeagleWrite font to a text representation.
47+
* [convert_font.pl](convert_font.pl)
48+
* Converts an HRCG font to an MGTK font.
49+
* [dump_font.pl](dump_font.pl)
50+
* Dumps an MGTK font to a text representation.
51+
* [make_font.pl](make_font.pl)
52+
* Converts a text representation of a font to an MGTK font.
53+
54+
## Development Utilities
55+
56+
* [asmfmt.pl](asmfmt.pl)
57+
* Applies some of the coding style guidelines to a source file.
58+
* [audit_das](audit_das)
59+
* Shows the size of the Main and Aux segments of all desk accessories.
60+
* [endproc.pl](endproc.pl)
61+
* Applies the coding style guidelines for `.endproc` comments.
62+
* [md5](md5)
63+
* Generates MD5 checksums for all built files. Useful for ensuring a change does not alter the binaries in any way.
64+
* [stats.pl](stats.pl)
65+
* Provides statistics about the disassembly status of source files.
66+
67+
## Miscellaneous
68+
69+
* [check_ver.pl](check_ver.pl)
70+
* Verify that the version string (e.g. from a build tool) matches out minimum requirements.
71+
* [colorize](colorize)
72+
* Runs the passed command, and format any error output as red. Used in various Makefiles.
73+
* [hr2dhr.pl](hr2dhr.pl)
74+
* Generates the tables used to convert an image from single hi-res to double hi-res form.
75+
* [packbytes.pl](packbytes.pl)
76+
* Compresses the input to the "PackBytes" format.
77+
* [unpackbytes.pl](unpackbytes.pl)
78+
* Decompresses the input from the "PackBytes" format.
79+
* [util.sh](util.sh)
80+
* Helper functions used in other shell scripts.

bin/refactor.pl

Lines changed: 0 additions & 250 deletions
This file was deleted.

0 commit comments

Comments
 (0)