4 READMEs
| (require distro-build/readme) | |
| package: distro-build-server | |
The
distro-build/readme library provides functions for
constructing a "README" file’s content. Each function takes a
hash table mapping configuration keywords to values.
procedure
(make-readme config) → string?
config : hash?
Produces basic "README" content, using information about the
distribution and the Racket license. The content is constructed using
config keys such as #:name, #:target-platform,
#:dist-name, and #:dist-catalogs, and sometimes
current-stamp. Some content depends on the result of
(readme-system-type config).
procedure
(make-macosx-notes config) → string?
config : hash?
Produces "README" content to tell Mac OS users how to install a
distribution folder. This function is used by make-readme when
#:platform in config is 'macosx.
procedure
(readme-system-type config) → (or/c 'unix 'macosx 'windows)
config : hash?
Determines the kind of platform for a generated "README"
file:
If '#:target-platform has a non-#f value in config, the value is returned.
Otherwise, if '#:cross-target has a string value, then a system type is inferred if it contains any of the following fragments: mingw implies 'windows, darwin implies 'macosx, and linux implies 'unix.
If the above fail, the value of '#:platform is returned, if it is mapped in config.
As a last resort, (system-type) is returned.