Skip to content

Commit a55b94e

Browse files
update readme
1 parent 6101a26 commit a55b94e

File tree

1 file changed

+49
-12
lines changed

1 file changed

+49
-12
lines changed

README.md

Lines changed: 49 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# **Fossil IO Library by Fossil Logic**
22

3-
Fossil IO is a comprehensive and portable library designed to handle input, output, and error management across various platforms. It provides a robust suite of functions for secure data handling, file stream management, and error reporting. Implemented in C, Fossil IO aims to facilitate high-performance and reliable I/O operations while ensuring consistent behavior across different operating systems.
3+
Fossil IO is an extensive and versatile library meticulously crafted to manage input, output, and error handling across a multitude of platforms. This library offers a comprehensive array of functions dedicated to secure data handling, efficient file stream management, and detailed error reporting. Developed in the C programming language, Fossil IO is engineered to support high-performance and reliable I/O operations, ensuring uniform and predictable behavior across various operating systems, including Windows, macOS, and Linux. By leveraging Fossil IO, developers can achieve consistent and secure I/O operations, making it an indispensable tool for cross-platform software development.
44

55
## Key Features
66

@@ -12,40 +12,77 @@ Fossil IO is a comprehensive and portable library designed to handle input, outp
1212

1313
## Prerequisites
1414

15-
Before using Fossil IO, ensure you have the following installed:
15+
To get started with Fossil Io, ensure you have the following installed:
1616

17-
- **C Compiler**: A C compiler compatible with your platform.
18-
- **Build System**: Meson or CMake for building the library.
17+
- **Meson Build System**: If you don’t have Meson installed, follow the installation instructions on the official [Meson website](https://mesonbuild.com/Getting-meson.html).
18+
- **CMake Build System**: If you don’t have CMake installed, follow the installation instructions on the official [CMake website](https://cmake.org/getting-started/).
1919

20-
## Adding Dependency
20+
### Adding Fossil Test Dependency
2121

22-
1. **Install Build Tools**: Ensure that Meson or CMake is installed on your system. You can install Meson using pip:
22+
#### Adding Fossil Test Dependency With Meson
2323

24+
1. **Install Meson Build System**:
25+
Install Meson version `1.3` or newer:
2426
```sh
25-
python -m pip install meson # to install Meson
26-
python -m pip install --upgrade meson # to upgrade Meson
27+
python -m pip install meson # To install Meson
28+
python -m pip install --upgrade meson # To upgrade Meson
2729
```
2830

29-
2. **Adding Wrap File**: If using Meson, create a `.wrap` file in the `subprojects` directory, such as `fossil-io.wrap`:
31+
2. **Create a `.wrap` File**:
32+
Add the `fossil-io.wrap` file in your `subprojects` directory and include the following content:
3033

3134
```ini
3235
# ======================
3336
# Git Wrap package definition
3437
# ======================
3538
[wrap-git]
3639
url = https://github.com/fossillogic/fossil-io.git
37-
revision = v0.1.1
40+
revision = v0.1.3
3841

3942
[provide]
4043
fossil-io = fossil_io_dep
4144
```
4245

43-
3. **Integrate the New Dependency**: Add the following line to your `meson.build` file to integrate the dependency:
44-
46+
3. **Integrate the Dependency**:
47+
In your `meson.build` file, integrate Fossil Io by adding the following line:
4548
```ini
4649
dep = dependency('fossil-io')
4750
```
4851

52+
---
53+
54+
#### Adding Fossil Test Dependency With CMake
55+
56+
To use Fossil Io with CMake, follow these steps:
57+
58+
1. **Install CMake**:
59+
Install CMake version `3.13.4` or newer:
60+
61+
```sh
62+
python -m pip install cmake # To install CMake
63+
python -m pip install --upgrade cmake # To upgrade CMake
64+
```
65+
66+
2. **Find and Integrate Fossil Test**:
67+
After installing CMake, you can integrate Fossil Io as a dependency. Add the following lines to your `CMakeLists.txt` file:
68+
69+
```cmake
70+
# Find Fossil Io package
71+
find_package(FossilIo REQUIRED)
72+
73+
# Link the Fossil Io to your project
74+
target_link_libraries(your_target FossilIo)
75+
```
76+
77+
3. **Configure Your CMake Project**:
78+
Make sure to configure your CMake project to include the necessary paths and dependencies for Fossil Io. Typically, you’ll want to make sure the `FossilIo` library is correctly linked in your build configuration.
79+
80+
This will ensure that Fossil Io is included and properly built with your project.
81+
82+
---
83+
84+
**Note**: For the best experience, always use the latest release of Fossil Test. Visit the [Fossil Io Releases](https://github.com/fossillogic/fossil-io/releases) page for the latest versions.
85+
4986
## Configure Options
5087

5188
Fossil IO offers configurable options to tailor the build process to your needs:

0 commit comments

Comments
 (0)