@@ -53,24 +53,6 @@ cabal install vty
5353
5454* Provides a comprehensive test suite.
5555
56−# Known Issues
57−
58−* Terminals have numerous quirks and bugs. Vty picks what works best for
59− the author in ambiguous or buggy situations.
60−
61−* Signal handling of STOP, TERM and INT are nonexistent.
62−
63−* The character encoding of the terminal is assumed to be UTF-8 if
64− unicode is used.
65−
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
69− particular terminal.
70−
71−* Uses the `TIOCGWINSZ` ioctl to find the current window size, which
72− appears to be limited to Linux and BSD.
73−
7456* Supports "normal" and "extended" (SGR) mouse modes as described at
7557 http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking
7658
@@ -88,6 +70,18 @@ handle some omissions from terminfo.
8870
8971Unsupported (but contributions and testing here are very welcome!)
9072
73+# Contributing
74+
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:
77+
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.
84+
9185# Development Notes
9286
9387## Under NixOS
@@ -120,3 +114,21 @@ rm -rf dist ; cabal configure --enable-tests --disable-library-coverage \
120114 --enable-library-profiling \
121115 --enable-executable-profiling
122116~~~
117+
118+# Known Issues
119+
120+* Terminals have numerous quirks and bugs. Vty picks what works best for
121+ the author in ambiguous or buggy situations.
122+
123+* Signal handling of STOP, TERM and INT are nonexistent.
124+
125+* The character encoding of the terminal is assumed to be UTF-8 if
126+ unicode is used.
127+
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.
132+
133+* Uses the `TIOCGWINSZ` ioctl to find the current window size, which
134+ appears to be limited to Linux and BSD.