README 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. This document is released under the LGPL v3 or later, and GFDL v1.3 or
  2. later, as published by the FSF (including this file!)
  3. I hope it's helpful generally to you in learning how Guile works.
  4. Patches welcome, also!
  5. A note on style
  6. ===============
  7. I tried to set up the format of documentation so that patching it
  8. should be easy while keeping the source readable. To demonstrate,
  9. here's an example:
  10. (p [You also might build up some fun toys while running through this
  11. tutorial.
  12. You might want to play with them and re-use them without having
  13. to type them in all over again.
  14. This is where your text editor comes into play!
  15. Try opening a new file, we'll call it "sandbox.scm".
  16. When you build something in this tutorial you'd like to use
  17. over and over again without retyping it between REPL sessions,
  18. you can put it here.
  19. Let's try putting something there now:])
  20. What you'll notice is that each new sentence starts on its own line.
  21. Sentences which have characters which continue beyond line 79 "wrap",
  22. but are indented to be clear that they align with a previous sentence.
  23. This is an unusual convention, but I think a sane one: my usual
  24. temptation is to use emacs' fill-paragraph technique to keep things
  25. looking nice in plaintext, but that can entirely rearrange paragraphs,
  26. and in my experience makes merging changes hard. I heard the
  27. recommendation a while ago that keeping a sentence on its own line is a
  28. better way to go for version-controlled documentation, but usually that
  29. ends up flying off beyond column 80, and I hate that. So the above
  30. approach merges the two.