diff options
author | Case Duckworth | 2024-06-15 21:17:03 -0500 |
---|---|---|
committer | Case Duckworth | 2024-06-15 21:17:03 -0500 |
commit | 703e9e93087d32364087a0ebc9e315869b70ff7c (patch) | |
tree | de5cfdd1a687dbe68686929497e870fad5f28800 /README.gmi | |
parent | Write executable (diff) | |
download | jimmy-703e9e93087d32364087a0ebc9e315869b70ff7c.tar.gz jimmy-703e9e93087d32364087a0ebc9e315869b70ff7c.zip |
Update things
Diffstat (limited to 'README.gmi')
-rw-r--r-- | README.gmi | 32 |
1 files changed, 28 insertions, 4 deletions
diff --git a/README.gmi b/README.gmi index a3e10fd..88dde93 100644 --- a/README.gmi +++ b/README.gmi | |||
@@ -38,12 +38,12 @@ offers a normalization function. | |||
38 | tags do not stretch over source line breaks, and there is no check as to | 38 | tags do not stretch over source line breaks, and there is no check as to |
39 | whether they're properly nested. | 39 | whether they're properly nested. |
40 | 40 | ||
41 | ### Incompatible changes | 41 | ### Incompatible changes (UNIMPLEMENTED) |
42 | 42 | ||
43 | This section should be as short as possible, of course. They're incompatible in | 43 | This section should be as short as possible, of course. They're incompatible in |
44 | that a complying gemtext reader will interpret their meanings as different from | 44 | that a complying gemtext reader will interpret their meanings as different from |
45 | what jimmy text outputs. These changes are behind a flag (TODO!) and can be | 45 | what jimmy text outputs. These changes are behind a flag and can be disabled at |
46 | disabled at run-time. | 46 | run-time. |
47 | 47 | ||
48 | * Lines beginning with two or more spaces are automatically joined with the | 48 | * Lines beginning with two or more spaces are automatically joined with the |
49 | previous line on output. | 49 | previous line on output. |
@@ -52,6 +52,7 @@ disabled at run-time. | |||
52 | 52 | ||
53 | Jimmy requires CHICKEN 5.3+ as well as the following eggs: | 53 | Jimmy requires CHICKEN 5.3+ as well as the following eggs: |
54 | 54 | ||
55 | * args | ||
55 | * module-declarations | 56 | * module-declarations |
56 | * utf8 | 57 | * utf8 |
57 | 58 | ||
@@ -59,7 +60,30 @@ To install, simply run `make install`. You can uninstall with `make uninstall`. | |||
59 | 60 | ||
60 | ## Using jimmy | 61 | ## Using jimmy |
61 | 62 | ||
62 | TODO | 63 | You can run jimmy on the command line as a filter or on a file. Run it like |
64 | this: | ||
65 | |||
66 | ``` | ||
67 | jimmy [OPTIONS...] [FILE] | ||
68 | ``` | ||
69 | |||
70 | FILE, if present, is the file to read; otherwise read standard input. | ||
71 | |||
72 | The available options comprise | ||
73 | |||
74 | * *-t, --to=FORMAT* --- Translate the input to FORMAT, one of `gemini`, `html`, | ||
75 | or a filename with format specifications in it (see OUTPUT FORMATS, below). | ||
76 | * *-n, --no-extensions* --- Don't enable any of the breaking extensions to | ||
77 | gemtext outlined above (NOT IMPLEMENTED) | ||
78 | * *-T, --template=TEMPLATE* --- Wrap the generated text in TEMPLATE using | ||
79 | metadata from the document (see TEMPLATES, below). | ||
80 | * -h, --help --- Show the help text and exit | ||
81 | |||
82 | ### Output Formats | ||
83 | |||
84 | |||
85 | |||
86 | ### Templates | ||
63 | 87 | ||
64 | ## License | 88 | ## License |
65 | 89 | ||