Merge pull request #8 from 7bitcoder/dev

Release 1.0.0 version

Author: 7bitcoder

.github/workflows/DevCI.yml

@@ -6,13 +6,8 @@ on:
     paths-ignore:
       - "Docs/**"
       - ".readthedocs.yaml"
-      - "Readme.md"
-  pull_request:
-    branches: ["dev"]
-    paths-ignore:
-      - "Docs/**"
-      - ".readthedocs.yaml"
-      - "Readme.md"
+      - "README.md"
+
 env:
   BUILD_TYPE: Release
   BUILD_DIR: ${{github.workspace}}/build

.github/workflows/MainCI.yml

@@ -1,18 +1,12 @@
 name: MainCI
 
 on:
-  push:
-    branches: ["main"]
-    paths-ignore:
-      - "Docs/**"
-      - ".readthedocs.yaml"
-      - "Readme.md"
   pull_request:
     branches: ["main"]
     paths-ignore:
       - "Docs/**"
       - ".readthedocs.yaml"
-      - "Readme.md"
+      - "README.md"
 
 env:
   BUILD_TYPE: Release

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.15.0)
-project(7bitInjector VERSION 0.1.0)
+project(7bitInjector VERSION 1.0.0)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)

Docs/advanced-guides/building-library.rst

@@ -1,31 +1,76 @@
-Building Library
+Build Library
 ==========================
 
-The library can be built locally using Cmake_ (`Cmake Installation`_), and several cache variables can be set:
+The library can be built locally using Cmake_ (`Cmake Installation`_)
+
+Create a build directory and navigate to it:
+
+.. code-block:: sh
+
+    mkdir build && cd build
+
+Configure CMake project
+
+.. code-block:: sh
+
+    cmake .. -DCMAKE_BUILD_TYPE=Debug
+
+Using this command several cache variables can be set:
 
 * <variable cache name>: [possible values] (default value) - Description
 * LIBRARY_TYPE: ["Shared", "Static", "HeaderOnly"] ("HeaderOnly") - Library build type
 * BUILD_DOCS: [true, false] (false) - Turn on to build documentation (requires Sphinx_, Breathe_ and Doxygen_ installed)
-* BUILD_TESTS: [true, false] (false) - Turn on to build tests (requires Gtest_ to be installed, see `Conan Packages Installation`_)
+* BUILD_TESTS: [true, false] (false) - Turn on to build tests (requires Gtest_ to be installed, see `Build Library With Conan`_)
 * BUILD_EXAMPLES: [true, false] (false) - Turn on to build examples
 
-build the library using the command:
+to set cache variable pass additional option: -D<variable cache name>=[value] 
+for example, this command will set the library type to Static and will force examples built
 
 .. code-block:: sh
 
-    cmake --build ./build
+    cmake .. -DCMAKE_BUILD_TYPE=Release -DLIBRARY_TYPE=Static -DBUILD_EXAMPLES=true
+
+Build the library using the command:
+
+.. code-block:: sh
 
+    cmake --build .
 
-Conan Packages Installation
+
+Build Library With Conan
 ^^^^^^^^^^^^^^^
 
 Gtest_ library is added to project using Conan_ package manager (`Conan Installation`_), 
-to install Conan packages run this command in the library root folder:
+If Conan was freshly installed run detect command:
+
+.. code-block:: sh
+
+    conan profile detect
+
+To install Conan packages run this command in the library root folder:
 
 .. code-block:: sh
 
     conan install . --output-folder=build --build=missing
 
+Navigate to the build directory:
+
+.. code-block:: sh
+
+    cd build
+
+Configure the CMake project, and add also toolchain file as a CMAKE_TOOLCHAIN_FILE cache variable:
+
+.. code-block:: sh
+
+    cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=true -DCMAKE_TOOLCHAIN_FILE:STRING="conan_toolchain.cmake"
+
+Build the library using the command:
+
+.. code-block:: sh
+
+    cmake --build .
+
 .. _Cmake: https://cmake.org/
 .. _`Cmake Installation`: https://cmake.org/download/
 .. _Sphinx: https://www.sphinx-doc.org/en/master/

Docs/advanced-guides/external-singleton.rst

@@ -3,8 +3,8 @@ External Singleton
 
 Singleton can be registered externally
 
-.. literalinclude:: ../../Examples/ExternalSingleton.cpp
-   :caption: Examples/ExternalSingleton
+.. literalinclude:: ../../Examples/Guides/ExternalSingleton.cpp
+   :caption: Examples/Guides/ExternalSingleton
    :language: C++
 
 .. code-block:: console

Docs/advanced-guides/using-factories.rst

@@ -1,11 +1,12 @@
 Using Factories
 ========================================
 
-Factory functor can be provided to manually create a service. Functor should return unique_ptr and as an argument should optionally take reference to the service provider.
+Factory functor can be provided to manually create a service. 
+Functor should return unique_ptr and as an argument should optionally take reference to the service provider.
 Functor scheme (IServiceProvider &) -> std::unique_ptr or () -> std::unique_ptr
 
-.. literalinclude:: ../../Examples/FactoryFunctions.cpp
-   :caption: Examples/FactoryFunctions
+.. literalinclude:: ../../Examples/Guides/FactoryFunctions.cpp
+   :caption: Examples/Guides/FactoryFunctions
    :language: C++
 
 .. code-block:: console

Docs/basic-guides/core-classes.rst

@@ -9,6 +9,6 @@ The library relies on two core classes:
 .. _ServiceCollection: ../reference/di/servicecollection.html
 .. _IServiceProvider: ../reference/di/iserviceprovider.html
 
-.. literalinclude:: ../../Examples/CoreClasses.cpp
-   :caption: Examples/Basic
+.. literalinclude:: ../../Examples/Guides/CoreClasses.cpp
+   :caption: Examples/Guides/Basic
    :language: C++

Docs/basic-guides/injecting-multiple-services.rst

@@ -9,13 +9,13 @@ Multiple services can inherit one interface and can be injected using a vector.
 
    Injection rules are simple:
 
-   * It is guaranteed that vectors won't contain null pointners
+   * It is guaranteed that vectors won't contain null pointers 
    * Singleton/scoped services should be injected using std::vector<pointners> 
    * Transient services should be injected using std::vector<std::unique_ptr> 
 
 
-.. literalinclude:: ../../Examples/InjectingMultipleServices.cpp
-   :caption: Examples/InjectingMultipleServices
+.. literalinclude:: ../../Examples/Guides/InjectingMultipleServices.cpp
+   :caption: Examples/Guides/InjectingMultipleServices
    :language: C++
 
 .. code-block:: console

Docs/basic-guides/injecting-service-provider.rst

@@ -3,8 +3,8 @@ Injecting Service Provider
 
 Service Provider object can be injected and can be used to manually get (scoped/singletons) or create (transient) services.
 
-.. literalinclude:: ../../Examples/InjectingServiceProvider.cpp
-   :caption: Examples/InjectingServiceProvider
+.. literalinclude:: ../../Examples/Guides/InjectingServiceProvider.cpp
+   :caption: Examples/Guides/InjectingServiceProvider
    :language: C++
 
 .. code-block:: console

Docs/basic-guides/injecting-services.rst

@@ -8,11 +8,11 @@ This example shows the main purpose of this library, injecting services into ser
 
    * Service should have one constructor
    * It is guaranteed that injected service won`t be null
-   * Singleton/scoped service should be injected using pointners (references are not allowed due to library limitations, it might be fixed in the future) 
+   * Singleton/scoped service should be injected using pointers (references are not allowed due to library limitations, it might be fixed in the future) 
    * Transient services should be injected using std::unique_ptr 
 
-.. literalinclude:: ../../Examples/InjectingServices.cpp
-   :caption: Examples/InjectingServices
+.. literalinclude:: ../../Examples/Guides/InjectingServices.cpp
+   :caption: Examples/Guides/InjectingServices
    :language: C++
 
 .. code-block:: console