Newer
Older
twander / READ-1ST.txt
  1. 'twander' QUICKSTART
  2. ====================
  3.  
  4. Everyone seems to hate reading documentation, so this is a fast-track
  5. to getting started with 'twander'. However, a lot of time and
  6. skull-sweat went into writing THE DOCS and you really should take the
  7. time to read them if you want to truly understand this program and
  8. what it can do for you:
  9.  
  10. - NOTE: 'twander' is a tool for experienced Power Users and
  11. Programmers. You need to understand the command shell and scripting
  12. on your system in order to effectively use the program. If you do
  13. not, you will become quickly frustrated with 'twander', so spare
  14. yourself the aggravation.
  15.  
  16. - Unpack the distribution tarball someplace safe.
  17.  
  18. - Installation is *manual*. The only exception is on FreeBSD where
  19. there is (or soon will be) a port for this program. The 'Makefile'
  20. in the distribution archive is only for the FreeBSD port and should
  21. not be used elsewhere. THE DOCS have a nice short section on
  22. installation on various OSs.
  23.  
  24. - The example '.twander' configuration file has everything commented
  25. out. If you start the program with this configuration, *you will
  26. have no commands defined*. Several simple Command Definition
  27. examples can be found in this file, so you can get started quickly
  28. by uncommenting one or more of them. THE DOCS have a nice long
  29. section on writing command definitions.
  30.  
  31. - There are a great many defaults for Key Bindings and Program Options
  32. which can be overriden in the Configuration File. The example
  33. '.twander' file provided in the distribution tarball lists every one
  34. of them (and their default value, if any) as a comment. The
  35. simplest way to change a default is to copy the relevant entry,
  36. uncomment, and edit that copy. That way you always have
  37. documentation about the default in your configuration. Details
  38. about each of these options can be found in THE DOCS.
  39.  
  40. - This is a very powerful program with a nifty little macro language.
  41. You have to READ THE DOCS to really understand and exploit what's
  42. going on here.
  43.  
  44. - You would be well served to join the 'twander-users' mailing list as
  45. documented in THE DOCS.
  46.  
  47.  
  48.