Skip to content

Commit

Permalink
Improve the README
Browse files Browse the repository at this point in the history
  • Loading branch information
rikyoz committed Nov 9, 2024
1 parent 3d389f1 commit b765d47
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,13 @@ It supports compression and extraction to and from the filesystem or the memory,

> [!NOTE]
>
> The presence or not of some of the above features depends on the particular shared library used along with bit7z.<br/>
> For example, 7z.dll should support all these features, 7za.dll should work only with the 7z file format, and 7zxa.dll can only extract 7z files. For more information about the 7-zip DLLs, please check this [wiki page](https://github.com/rikyoz/bit7z/wiki/7z-DLLs).
> The presence or not of some of the above features depends on the particular shared library used along with bit7z. For example, 7z.dll should support all these features, 7za.dll should work only with the 7z file format, and 7zxa.dll can only extract 7z files.
>
> In the end, some other features (e.g., _automatic format detection_ and _selective extraction using regular expressions_) are disabled by default, and macro definitions must be used during compilation to have them available ([wiki](https://github.com/rikyoz/bit7z/wiki/Building-the-library)).
> For more information about the 7-zip DLLs, please check this [wiki page](https://github.com/rikyoz/bit7z/wiki/7z-DLLs).
> [!NOTE]
>
> Some other features (e.g., _automatic format detection_ and _selective extraction using regular expressions_) are disabled by default, and macro definitions must be used during compilation to have them available ([wiki](https://github.com/rikyoz/bit7z/wiki/Building-the-library)).
## 🔥 Getting Started (Library Usage)

Expand Down Expand Up @@ -279,7 +282,8 @@ Bit7z can be used as a dependency in several alternative ways:
```cmake
CPMAddPackage("gh:rikyoz/bit7z@<version>") # Replace <version> with the version of bit7z you want to use.
# To enable/disable build options, use set(BIT7Z_<OPTION NAME> ON CACHE BOOL "enable option" FORCE) here.
# Set bit7z's build options you want here, e.g.:
# set(BIT7Z_AUTO_FORMAT ON CACHE BOOL "enable auto format support" FORCE)
target_link_libraries(${YOUR_TARGET} PRIVATE bit7z)
```

Expand Down Expand Up @@ -310,7 +314,8 @@ For example:

```cmake
add_subdirectory(${CMAKE_SOURCE_DIR}/third_party/bit7z)
# To enable/disable build options, use set(BIT7Z_<OPTION NAME> ON CACHE BOOL "enable option" FORCE) here.
# Set bit7z's build options you want here, e.g.:
# set(BIT7Z_USE_NATIVE_STRING ON CACHE BOOL "enable using native OS strings" FORCE)
target_link_libraries(${YOUR_TARGET} PRIVATE bit7z)
```

Expand All @@ -333,7 +338,7 @@ Once built, you can copy the library file and bit7z's `include` folder in the de

```cmake
target_include_directories(${YOUR_TARGET} PRIVATE "<path-to-bit7z-include-folder>")
target_link_directories(${YOUR_TARGET} PRIVATE "<path-to-bit7z-lib-folder>")
link_directories(${YOUR_TARGET} PRIVATE "<path-to-bit7z-lib-folder>")
target_link_libraries(${YOUR_TARGET} PRIVATE bit7z)
```

Expand Down

0 comments on commit b765d47

Please sign in to comment.