Skip to content

Commit 14044c7

Browse files
authored
Merge pull request #17 from 7bitcoder/dev
update documentation
2 parents defbeb1 + f29600a commit 14044c7

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

Docs/getting-started.rst

+6-1
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,12 @@ Installation
3636
FetchContent_Declare(
3737
7bitDI
3838
GIT_REPOSITORY https://github.com/7bitcoder/7bitDI.git
39-
GIT_TAG 86228173f14f449dde88a84c549474ba43c2fd25 # proper release tag for example 1.0.0
39+
GIT_TAG defbeb195e11367c5906564e33748ca7494dee88 # release 2.0.0
4040
)
4141
FetchContent_MakeAvailable(7bitDI)
4242
43+
target_link_libraries(Target 7bitDI::7bitDI)
44+
4345
#. Using Conan.io package manager
4446
Download and install Conan_, and create conanfile.txt in the root of your project for example:
4547

@@ -54,6 +56,8 @@ Installation
5456
5557
conan install . --output-folder=build --build=missing
5658
59+
Follow in detail instructions available at `Conan Tutorial`_
60+
5761
#. Header only
5862
Download source code from the most recent release,
5963
copy include folder into your project location,
@@ -88,6 +92,7 @@ The next chapters will in detail, step by step explain what is going on in this
8892
8993
9094
.. _Conan: https://conan.io/
95+
.. _`Conan Tutorial`: https://docs.conan.io/2/tutorial/consuming_packages/build_simple_cmake_project.html
9196
.. _CMake: https://cmake.org/
9297
.. _7bitDI: https://github.com/7bitcoder/7bitDI
9398
.. _`Building Library`: advanced-guides/building-library.html

README.md

+12-7
Original file line numberDiff line numberDiff line change
@@ -59,16 +59,18 @@ include(FetchContent)
5959
FetchContent_Declare(
6060
7bitDI
6161
GIT_REPOSITORY https://github.com/7bitcoder/7bitDI.git
62-
GIT_TAG 86228173f14f449dde88a84c549474ba43c2fd25 # proper release tag for example 1.0.0
62+
GIT_TAG defbeb195e11367c5906564e33748ca7494dee88 # release 2.0.0
6363
)
6464
FetchContent_MakeAvailable(7bitDI)
65+
66+
target_link_libraries(Target 7bitDI::7bitDI)
6567
```
6668

6769
### 2. Using Conan.io package manager
6870

6971
Download and install A [Conan](https://conan.io/), and create conanfile.txt in the root of your project for example:
7072

71-
```txt
73+
```
7274
[requires]
7375
7bitdi/2.0.0
7476
```
@@ -79,11 +81,14 @@ change the version to newer if available, then run the command:
7981
conan install . --output-folder=build --build=missing
8082
```
8183

84+
Follow in detail instructions available
85+
at [Conan Tutorial](https://docs.conan.io/2/tutorial/consuming_packages/build_simple_cmake_project.html)
86+
8287
### 3. Header only
8388

8489
Download source code from the most recent release,
85-
copy include folder into your project location,
86-
for example copy into the '/SevenBitDI' folder.
90+
copy include folder into your project location.
91+
For example copy into the '/SevenBitDI' folder.
8792
Include this folder into the project, with [Cmake](https://cmake.org/), u can use:
8893

8994
```cmake
@@ -101,14 +106,14 @@ Download source code from the most recent release, build or install the project
101106
for more details see the Building Library guide
102107
in [Documentation](https://7bitdi.readthedocs.io/en/latest/getting-started.html).
103108

109+
## Injection Rules
110+
104111
### The library relies on two core classes:
105112

106113
* ServiceCollection: class is responsible for registering services and building service provider
107114
* ServiceProvider: class is responsible for delivering real services and managing its lifetime
108115

109-
## Injection Rules
110-
111-
The dependency injection system relies heavily on template metaprogramming and it has some limitations.
116+
The dependency injection system relies heavily on template metaprogramming, and it has some limitations.
112117

113118
### General
114119

0 commit comments

Comments
 (0)