diff --git a/README.md b/README.md index f539bd5..d13b75c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[comment]: \page README Readme + # libeismultiplexer libeismultiplexer is a shared library that allows you to control EISmultiplexer devices. diff --git a/doc/libeismulitplexer.doxygen.in b/doc/libeismulitplexer.doxygen.in index c2a59db..26fd640 100644 --- a/doc/libeismulitplexer.doxygen.in +++ b/doc/libeismulitplexer.doxygen.in @@ -864,7 +864,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/eismultiplexer.h @CMAKE_CURRENT_SOURCE_DIR@/doc/mainpage.txt +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/eismultiplexer.h @CMAKE_CURRENT_SOURCE_DIR@/doc/mainpage.txt @CMAKE_CURRENT_SOURCE_DIR@/README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/doc/mainpage.txt b/doc/mainpage.txt index 907b92c..4016f16 100644 --- a/doc/mainpage.txt +++ b/doc/mainpage.txt @@ -1,6 +1,6 @@ /*! \mainpage libeismultiplexer manual -libeismultiplexer is a shared library that allows you to control EISmultiplexer devices +libeismultiplexer is a shared library that allows you to control EISmultiplexer devices. For build instructions please see the \ref README. An API reference can be found here: \subpage API diff --git a/options.h b/options.h index a2911ff..4295a0a 100644 --- a/options.h +++ b/options.h @@ -35,14 +35,14 @@ const char *argp_program_version = "eismulitplexer_cli"; const char *argp_program_bug_address = ""; -static char doc[] = "Applicaion to control eismultiplexer devices"; +static char doc[] = "Application to control eismultiplexer devices"; static char args_doc[] = "COMMAND"; static struct argp_option options[] = { {"interactive", 'i', 0, 0, "run in interactive mode" }, {"pipe", 'p', 0, 0, "run in pipe mode" }, - {"serial", 's', "[NUMMBER]", 0, "serial number of device to connect to"}, + {"serial", 's', "[NUMBER]", 0, "serial number of device to connect to"}, {"list", 'l', 0, 0, "list commands"}, {0} };