diff options
author | pgen <p.gen.progs@gmail.com> | 2021-10-28 22:40:46 +0200 |
---|---|---|
committer | pgen <p.gen.progs@gmail.com> | 2021-10-28 22:40:46 +0200 |
commit | ff4693a968c1b1be5268f9baaabd1baf19083d15 (patch) | |
tree | 8d8065d33a8e3f67c69280bf83009285b9947f07 | |
parent | 9fd0c1b33cf17b8450d64884b2b2ac1f7df1ab77 (diff) |
Update the README file
-rw-r--r-- | README.rst | 21 | ||||
-rw-r--r-- | utf8.c | 3 |
2 files changed, 11 insertions, 13 deletions
@@ -12,14 +12,17 @@ This tool takes words from standard input or from a file and presents them on the screen in different layouts in a scrolling window. A cursor that you can easily move lets you select one or more of them. -Note that the screen is not previously cleared when the scrolling window -of **smenu** is displayed. +Note that the screen is not cleared at the beginning and end of the +**smenu** execution. The selection window is displayed at the cursor +position and the previous contents of the terminal are not changed +or lost. I tried to make its use as simple as possible. It supports the ``UTF-8`` encoding and should work on all terminals managed by the ``terminfo`` database. -Please use the included man page to learn more about this little program. +Please refer to the included man page to learn more about this little +program. The `wiki <https://github.com/p-gen/smenu/wiki>`_ contains screenshots and animations that detail some concepts and features of **smenu**. @@ -31,12 +34,8 @@ development platform is available. This includes every Unix and Unix-like system I am aware of. Please use the provided ``build.sh`` script to build the executable. -This script accepts the same arguments as the GNU ``configure`` script, -type ``build.sh --help`` to see them. - -The script ``autogen.sh`` is also provided if you need to generate a -new ``configure`` script from ``configure.ac`` and ``Makefile.am``. The -GNU **autotools** will need to be installed for this script to work. +This script uses and accepts the same arguments as the GNU ``configure`` +script, type ``build.sh --help`` to see them. How to install it? ================== @@ -174,8 +173,8 @@ explained by differences in posix/libc/... implementations. This can notably occur when some specific regular expressions or uncommon ``UTF-8`` byte sequences are used. -If a test fails for unknown reason, then please send me its directory -name and the relevant ``.bad`` file. +If a test fails for an unknown reason, please send me the name of its +directory nd the corresponding ``.bad`` file. If you are hit by a bug that no test covers, then you can create a new test in the ``tests`` directory in an existing or new directory: read the @@ -381,8 +381,7 @@ utf8_sanitize(char * s, char substitute) } /* ======================================================================= */ -/* The utf8_validate() function scans the '\0'-terminated string starting */ -/* at s. */ +/* This function scans the '\0'-terminated string starting at s. */ /* It returns a pointer to the first byte of the first malformed */ /* or overlong UTF-8 sequence found, or NULL if the string contains only */ /* correct UTF-8. */ |