@@ -53,24 +53,6 @@ cabal install vty
54* Provides a comprehensive test suite.
54* Provides a comprehensive test suite.
58−* Terminals have numerous quirks and bugs. Vty picks what works best for
59− the author in ambiguous or buggy situations.
61−* Signal handling of STOP, TERM and INT are nonexistent.
63−* The character encoding of the terminal is assumed to be UTF-8 if
66−* Terminfo is assumed to be correct unless there is an override
67− configured. Some terminals will not have correct special key support
68− (shifted F10 etc). See `Config` for customizing vty's behavior for a
71−* Uses the `TIOCGWINSZ` ioctl to find the current window size, which
72− appears to be limited to Linux and BSD.
74* Supports "normal" and "extended" (SGR) mouse modes as described at
56* Supports "normal" and "extended" (SGR) mouse modes as described at
75 http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking
57 http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking
@@ -88,6 +70,18 @@ handle some omissions from terminfo.
89Unsupported (but contributions and testing here are very welcome!)
71Unsupported (but contributions and testing here are very welcome!)
75+If you decide to contribute, that's great! Here are some guidelines you
76+should consider to make submitting patches easier for all concerned:
78+ - If you want to take on big things, talk to me first; let's have a
79+ design/vision discussion before you start coding. Create a GitHub
80+ issue and we can use that as the place to hash things out.
81+ - If you make changes, make them consistent with the syntactic
82+ conventions already used in the codebase.
83+ - Please provide Haddock documentation for any changes you make.
91# Development Notes
85# Development Notes
93## Under NixOS
87## Under NixOS
@@ -120,3 +114,21 @@ rm -rf dist ; cabal configure --enable-tests --disable-library-coverage \
120 --enable-library-profiling \
114 --enable-library-profiling \
121 --enable-executable-profiling
115 --enable-executable-profiling
120+* Terminals have numerous quirks and bugs. Vty picks what works best for
121+ the author in ambiguous or buggy situations.
123+* Signal handling of STOP, TERM and INT are nonexistent.
125+* The character encoding of the terminal is assumed to be UTF-8 if
128+* Terminfo is assumed to be correct unless there is an override
129+ configured. Some terminals will not have correct special key support
130+ (shifted F10 etc). See `Config` for customizing vty's behavior for a
131+ particular terminal.
133+* Uses the `TIOCGWINSZ` ioctl to find the current window size, which
134+ appears to be limited to Linux and BSD.