diff options
author | Case Duckworth | 2024-02-06 22:17:09 -0600 |
---|---|---|
committer | Case Duckworth | 2024-02-06 22:17:09 -0600 |
commit | 7aba4f453f067976d928c8a030586414be449c70 (patch) | |
tree | aac0e63a3229bb18acc38358b4e8ed409b2c98f0 | |
parent | Update readme (diff) | |
download | subtext-main.tar.gz subtext-main.zip |
Add issues to readme main
-rw-r--r-- | readme.html | 20 | ||||
-rw-r--r-- | readme.st | 22 |
2 files changed, 42 insertions, 0 deletions
diff --git a/readme.html b/readme.html index a42f9a9..bb1ad19 100644 --- a/readme.html +++ b/readme.html | |||
@@ -131,6 +131,26 @@ look at readme.st to get a better feel for the syntax.</p> | |||
131 | 131 | ||
132 | <i>todo</i> | 132 | <i>todo</i> |
133 | 133 | ||
134 | <h2>Issues</h2> | ||
135 | |||
136 | <h3>Debugging</h3> | ||
137 | <p>Because shell's debugging tools are pretty bad, | ||
138 | and because of the multiple layers involved with | ||
139 | <code>subtext</code> | ||
140 | it can be pretty hard to debug. | ||
141 | It would be nice to figure out a way around this.</p> | ||
142 | |||
143 | <h3>Shell quoting issues</h3> | ||
144 | <p>If you've programmed in shell at all, | ||
145 | you'll know that quoting is ... difficult, | ||
146 | to say the least. | ||
147 | Because | ||
148 | <code>subtext</code> | ||
149 | expands to shell forms, it's vulnerable to similar issues | ||
150 | – especially on | ||
151 | <code>.</code> | ||
152 | lines.</p> | ||
153 | |||
134 | <h2>Contributing</h2> | 154 | <h2>Contributing</h2> |
135 | <p>Send me an email or whatever :) | 155 | <p>Send me an email or whatever :) |
136 | This project is licensed under the BSD-3 license. | 156 | This project is licensed under the BSD-3 license. |
diff --git a/readme.st b/readme.st index 2315ad3..abb7358 100644 --- a/readme.st +++ b/readme.st | |||
@@ -181,6 +181,28 @@ look at readme.st to get a better feel for the syntax. | |||
181 | 181 | ||
182 | .i todo | 182 | .i todo |
183 | 183 | ||
184 | .h2 Issues | ||
185 | |||
186 | .h3 Debugging | ||
187 | |||
188 | Because shell's debugging tools are pretty bad, | ||
189 | and because of the multiple layers involved with | ||
190 | .subtext , | ||
191 | it can be pretty hard to debug. | ||
192 | It would be nice to figure out a way around this. | ||
193 | |||
194 | .h3 Shell quoting issues | ||
195 | |||
196 | If you've programmed in shell at all, | ||
197 | you'll know that quoting is ... difficult, | ||
198 | to say the least. | ||
199 | Because | ||
200 | .subtext | ||
201 | expands to shell forms, it's vulnerable to similar issues | ||
202 | – especially on | ||
203 | .code . | ||
204 | lines. | ||
205 | |||
184 | .h2 Contributing | 206 | .h2 Contributing |
185 | 207 | ||
186 | Send me an email or whatever :) | 208 | Send me an email or whatever :) |