Moves files to include directory.

Makefile.am

@@ -6,11 +6,13 @@ DISTCHECK_CONFIGURE_FLAGS = CPPFLAGS="$(BOOST_CPPFLAGS) $(CPPFLAGS)" LDFLAGS="$(
 
 AM_CPPFLAGS =
 AM_CPPFLAGS += $(BOOST_CPPFLAGS)
-#AM_CPPFLAGS += -I$(top_srcdir)/include
+AM_CPPFLAGS += -I$(top_srcdir)/include
 
 AM_LDFLAGS =
 AM_LDFLAGS += -pthread
 
+SUBDIRS = include
+
 check_PROGRAMS =
 check_PROGRAMS += intro_sync
 check_PROGRAMS += intro
@@ -48,30 +50,6 @@ echo_server_direct_SOURCES = $(top_srcdir)/benchmarks/cpp/asio/echo_server_direc
 echo_server_client_SOURCES = $(top_srcdir)/benchmarks/cpp/asio/echo_server_client.cpp
 endif
 
-nobase_include_HEADERS =\
-  $(top_srcdir)/aedis/src.hpp\
-  $(top_srcdir)/aedis/error.hpp\
-  $(top_srcdir)/aedis/impl/error.ipp\
-  $(top_srcdir)/aedis/detail/net.hpp\
-  $(top_srcdir)/aedis/connection.hpp\
-  $(top_srcdir)/aedis/adapt.hpp\
-  $(top_srcdir)/aedis/detail/connection_ops.hpp\
-  $(top_srcdir)/aedis/aedis.hpp\
-  $(top_srcdir)/aedis/adapter/detail/adapters.hpp\
-  $(top_srcdir)/aedis/adapter/adapt.hpp\
-  $(top_srcdir)/aedis/adapter/detail/response_traits.hpp\
-  $(top_srcdir)/aedis/resp3/node.hpp\
-  $(top_srcdir)/aedis/resp3/compose.hpp\
-  $(top_srcdir)/aedis/resp3/detail/read_ops.hpp\
-  $(top_srcdir)/aedis/resp3/detail/parser.hpp\
-  $(top_srcdir)/aedis/resp3/type.hpp\
-  $(top_srcdir)/aedis/resp3/read.hpp\
-  $(top_srcdir)/aedis/resp3/write.hpp\
-  $(top_srcdir)/aedis/resp3/request.hpp\
-  $(top_srcdir)/aedis/resp3/impl/request.ipp\
-  $(top_srcdir)/aedis/resp3/detail/impl/parser.ipp\
-  $(top_srcdir)/aedis/resp3/impl/type.ipp
-
 nobase_noinst_HEADERS =\
   $(top_srcdir)/examples/print.hpp\
   $(top_srcdir)/tests/check.hpp

README.md

@@ -1 +1 @@
-See https://mzimbres.github.io/aedis/
+See the official github-pages for documentation: https://mzimbres.github.io/aedis

configure.ac

@@ -2,6 +2,7 @@ AC_PREREQ([2.69])
 AC_INIT([Aedis], [0.2.1], [mzimbres@gmail.com])
 AC_CONFIG_MACRO_DIR([m4])
 AC_CONFIG_HEADERS([config.h])
+AC_CONFIG_SRCDIR(include/aedis.hpp)
 AM_INIT_AUTOMAKE([-Wall foreign])
 AC_LANG(C++)
 
@@ -49,5 +50,5 @@ AC_COMPILE_IFELSE(
 
 AM_CONDITIONAL(HAVE_COROUTINES,test x$HAVE_COROUTINES = xyes)
 
-AC_CONFIG_FILES([Makefile doc/Doxyfile])
+AC_CONFIG_FILES([Makefile include/Makefile doc/Doxyfile])
 AC_OUTPUT

doc/Doxyfile.in

@@ -44,7 +44,7 @@ PROJECT_NUMBER         = "@PACKAGE_VERSION@"
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "High level Redis client library"
+PROJECT_BRIEF          = "High level Redis client"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
@@ -823,7 +823,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = aedis examples
+INPUT                  = include benchmarks/benchmarks.md examples
 
 # 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

examples/chat_room.cpp

@@ -7,7 +7,7 @@
 #include <string>
 #include <iostream>
 #include <boost/asio.hpp>
-#include <aedis/aedis.hpp>
+#include <aedis.hpp>
 #include <aedis/src.hpp>
 
 #include "unistd.h"

examples/containers.cpp

@@ -7,7 +7,7 @@
 #include <map>
 #include <vector>
 #include <iostream>
-#include <aedis/aedis.hpp>
+#include <aedis.hpp>
 #include <aedis/src.hpp>
 #include "print.hpp"
 

examples/echo_server.cpp

@@ -7,7 +7,7 @@
 #include <string>
 #include <iostream>
 #include <boost/asio.hpp>
-#include <aedis/aedis.hpp>
+#include <aedis.hpp>
 #include <aedis/src.hpp>
 
 namespace net = boost::asio;

examples/intro.cpp

@@ -7,7 +7,7 @@
 #include <tuple>
 #include <string>
 #include <boost/asio.hpp>
-#include <aedis/aedis.hpp>
+#include <aedis.hpp>
 #include <aedis/src.hpp>
 
 namespace net = boost::asio;

examples/serialization.cpp

@@ -12,7 +12,7 @@
 #include <string>
 #include <boost/json.hpp>
 #include <boost/json/src.hpp>
-#include <aedis/aedis.hpp>
+#include <aedis.hpp>
 #include <aedis/src.hpp>
 #include "print.hpp"
 

examples/subscriber.cpp

@@ -8,7 +8,7 @@
 #include <vector>
 #include <iostream>
 #include <boost/asio.hpp>
-#include <aedis/aedis.hpp>
+#include <aedis.hpp>
 #include <aedis/src.hpp>
 
 namespace net = boost::asio;

include/Makefile.am

@@ -0,0 +1,24 @@
+
+nobase_include_HEADERS =\
+  $(top_srcdir)/include/aedis/src.hpp\
+  $(top_srcdir)/include/aedis/error.hpp\
+  $(top_srcdir)/include/aedis/impl/error.ipp\
+  $(top_srcdir)/include/aedis/detail/net.hpp\
+  $(top_srcdir)/include/aedis/connection.hpp\
+  $(top_srcdir)/include/aedis/adapt.hpp\
+  $(top_srcdir)/include/aedis/detail/connection_ops.hpp\
+  $(top_srcdir)/include/aedis.hpp\
+  $(top_srcdir)/include/aedis/adapter/detail/adapters.hpp\
+  $(top_srcdir)/include/aedis/adapter/adapt.hpp\
+  $(top_srcdir)/include/aedis/adapter/detail/response_traits.hpp\
+  $(top_srcdir)/include/aedis/resp3/node.hpp\
+  $(top_srcdir)/include/aedis/resp3/compose.hpp\
+  $(top_srcdir)/include/aedis/resp3/detail/read_ops.hpp\
+  $(top_srcdir)/include/aedis/resp3/detail/parser.hpp\
+  $(top_srcdir)/include/aedis/resp3/type.hpp\
+  $(top_srcdir)/include/aedis/resp3/read.hpp\
+  $(top_srcdir)/include/aedis/resp3/write.hpp\
+  $(top_srcdir)/include/aedis/resp3/request.hpp\
+  $(top_srcdir)/include/aedis/resp3/impl/request.ipp\
+  $(top_srcdir)/include/aedis/resp3/detail/impl/parser.ipp\
+  $(top_srcdir)/include/aedis/resp3/impl/type.ipp

include/aedis.hpp

@@ -12,21 +12,11 @@
 #include <aedis/connection.hpp>
 #include <aedis/resp3/request.hpp>
 
-// TODO: Support for Redis sentinel:
-// 
-//    - https://redis.io/docs/manual/sentinel and .
-//    - https://redis.io/docs/reference/sentinel-clients
-//
-// TODO: Should we avoid conflicts of
-//
-//    - aedis::adapt and
-//    - aedis::resp3::adapt
-//
-// function.
-
 /** \mainpage Documentation
     \tableofcontents
   
+    Useful links: \subpage any, [Benchmarks](benchmarks/benchmarks.md).
+
     \section Overview
   
     Aedis is a high-level [Redis](https://redis.io/) client library
@@ -390,32 +380,29 @@
     @li echo_server.cpp: A simple TCP echo server that users coroutines.
     @li chat_room.cpp: A simple chat room that uses coroutines.
 
-    \section using-aedis Using Aedis
+    \section using-aedis Installation
 
     To install and use Aedis you will need
   
     - Boost 1.78 or greater.
-    - Unix Shell and Make (for linux users).
-    - C++17. Some examples require C++20 with coroutine support.
-    - Redis server.
+    - C++17, some examples require C++20 with coroutine support.
+    - Redis server and optionally redis-cli and Redis Sentinel.
 
-    Some examples will also require interaction with
-  
-    - redis-cli: Used in one example.
-    - Redis Sentinel Server: used in some examples.
+    If you only want to test without installation
 
-    Aedis has been tested with the following compilers
-
-    - Tested with gcc: 12, 11.
-    - Tested with clang: 14, 13, 11.
-  
-    \section Installation
+    ```
+    # Download and unpack the latest release on github
+    $ wget https://github.com/mzimbres/aedis/releases/download/vversion/aedis-version.tar.gz
+    $ tar -xzvf aedis-version.tar.gz
+    $ cd aedis-version 
+    $ TODO
+    ```
 
     The first thing to do is to download and unpack Aedis
 
     ```
     # Download the latest release on github
-    $ wget https://github.com/mzimbres/aedis/releases
+    $ wget https://github.com/mzimbres/aedis/releases/download/version/aedis-version.tar.gz
   
     # Uncompress the tarball and cd into the dir
     $ tar -xzvf aedis-version.tar.gz
@@ -452,6 +439,13 @@
     $ make check
     ```
 
+    @subsection sup-comp Supported compilers
+
+    Aedis has been tested with the following compilers
+
+    - Tested with gcc: 12, 11.
+    - Tested with clang: 14, 13, 11.
+  
     \section Developers
   
     To generate the build system run
@@ -591,11 +585,6 @@
     @li Richard Hodges ([madmongo1](https://github.com/madmongo1)): For helping me with Asio and the design of asynchronous programs in general.
     @li Vinícius dos Santos Oliveira ([vinipsmaker](https://github.com/vinipsmaker)): For useful discussion about how Aedis consumes buffers in the read operation (among other things).
     @li Petr Dannhofer ([Eddie-cz](https://github.com/Eddie-cz)): For helping me understand how the `AUTH` and `HELLO` command can influence each other.
-
-    \section Reference
-  
-    See \subpage any.
-
  */
 
 /** \defgroup any Reference
@@ -603,4 +592,14 @@
  *  This page contains the documentation of all user facing code.
  */
 
+//  Support sentinel support as described in 
+//
+//  - https://redis.io/docs/manual/sentinel.
+//  - https://redis.io/docs/reference/sentinel-clients.
+//
+//  Avoid conflicts between
+//
+//  - aedis::adapt 
+//  - aedis::resp3::adapt.
+
 #endif // AEDIS_HPP

tests/high_level.cpp

@@ -12,7 +12,7 @@
 #include <boost/system/errc.hpp>
 #include <boost/asio/experimental/as_tuple.hpp>
 
-#include <aedis/aedis.hpp>
+#include <aedis.hpp>
 #include <aedis/src.hpp>
 
 #include "check.hpp"

tests/intro_sync.cpp

@@ -9,7 +9,7 @@
 
 #include <boost/asio/connect.hpp>
 
-#include <aedis/aedis.hpp>
+#include <aedis.hpp>
 #include <aedis/src.hpp>
 
 namespace net = boost::asio;

tests/low_level.cpp

@@ -16,7 +16,7 @@
 #include <boost/asio/co_spawn.hpp>
 #include <boost/beast/_experimental/test/stream.hpp>
 
-#include <aedis/aedis.hpp>
+#include <aedis.hpp>
 #include <aedis/src.hpp>
 
 #include "check.hpp"