diff options
| author | David Thompson <dthompson2@worcester.edu> | 2023-09-13 08:49:46 -0400 |
|---|---|---|
| committer | David Thompson <dthompson2@worcester.edu> | 2023-09-13 08:49:46 -0400 |
| commit | 30c85ede7bb57f7326f32a60a2eedac93b28990a (patch) | |
| tree | cec435c6c7615e1604e8d23fb25c9afdd37d7634 | |
| parent | 9a10647684cbe84e308360e217b774c4c0bd0389 (diff) | |
doc: Clear up confusion when using a REPL server with chickadee play.
| -rw-r--r-- | TODO.org | 8 | ||||
| -rw-r--r-- | doc/chickadee.texi | 9 |
2 files changed, 13 insertions, 4 deletions
@@ -6,10 +6,6 @@ doesn't mean anything to users. Also, make sure the docs explain why you need to clear first. Consider renaming =sprite-batch-clear!= to =sprite-batch-begin!= while you're at it. Explain the difference between capacity and size. -** TODO [#A] Mention (chickadee-user) module in 'chickadee play' docs -When you connect to the REPL server, it's in (guile-user) but there's -nothing telling the user to switch to the right default place. Can we -make the REPL automatically go to the right module? ** TODO [#A] Remove allocations in hot code paths - [ ] hash-for-each causes closure allocation in at least the shader, text, and audio modules @@ -119,6 +115,10 @@ naive way that does not use physically-based equations. ** TODO [#C] Right-to-left text rendering ** TODO [#C] Top-to-bottom text rendering ** TODO [#C] Octree spatial partitioning +** DONE [#A] Mention (chickadee-user) module in 'chickadee play' docs +When you connect to the REPL server, it's in (guile-user) but there's +nothing telling the user to switch to the right default place. Can we +make the REPL automatically go to the right module? ** DONE [#A] Improve window resizing support For example, there's no user hook to handle a resize event. ** DONE [#A] Images that can be rendered in Geiser REPL diff --git a/doc/chickadee.texi b/doc/chickadee.texi index 7c7e469..2c22744 100644 --- a/doc/chickadee.texi +++ b/doc/chickadee.texi @@ -284,6 +284,15 @@ Geiser} extension for Emacs is by far the best way to develop at the REPL with Guile. Use @code{M-x connect-to-guile} to connect to the REPL server. +Note that the REPL server defaults to the @code{(guile-user)} module, +so you will first need to switch to the @code{(chickadee-user)} module +like so: + +@example +scheme@(guile-user)> ,module (chickadee-user) +scheme@(chickadee-user)> +@end example + @item --language=@var{language} Process the input program using @var{language}, the identifier of a |