Skip to content

Commit 7587c1f

Browse files
Update README.md
1 parent 8022071 commit 7587c1f

File tree

1 file changed

+28
-31
lines changed

1 file changed

+28
-31
lines changed

README.md

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -28,37 +28,34 @@ To get started with Jellyfish, ensure you have the following installed:
2828

2929
- **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).
3030

31-
### Adding Jellyfish Dependency
32-
33-
#### Adding Jellyfish Dependency With Meson
34-
35-
1. **Install Meson Build System**:
36-
Install Meson version `1.3` or newer:
37-
```sh
38-
python -m pip install meson # To install Meson
39-
python -m pip install --upgrade meson # To upgrade Meson
40-
```
41-
42-
2. **Create a `.wrap` File**:
43-
Add the `fossil-jellyfish.wrap` file in your `subprojects` directory and include the following content:
44-
45-
```ini
46-
# ======================
47-
# Git Wrap package definition
48-
# ======================
49-
[wrap-git]
50-
url = https://github.com/fossillogic/fossil-jellyfish.git
51-
revision = v0.1.3
52-
53-
[provide]
54-
fossil-jellyfish = fossil_fish_dep
55-
```
56-
57-
3. **Integrate the Dependency**:
58-
In your `meson.build` file, integrate Jellyfish by adding the following line:
59-
```ini
60-
dep = dependency('fossil-jellyfish')
61-
```
31+
### Adding Dependency
32+
33+
#### Adding via Meson Git Wrap
34+
35+
To add a git-wrap, place a `.wrap` file in `subprojects` with the Git repo URL and revision, then use `dependency('fossil-jellyfish')` in `meson.build` so Meson can fetch and build it automatically.
36+
37+
#### Adding via Conan GitHub repository
38+
39+
packages directly from a GitHub repository if it contains a valid `conanfile.py`.
40+
41+
```bash
42+
conan install git+https://github.com/fossillogic/fossil-jellyfish.git#v0.1.4 --name fossil_jellyfish --build=missing
43+
```
44+
45+
#### Integrate the Dependency:
46+
47+
Add the `fossil-jellyfish.wrap` file in your `subprojects` directory and include the following content:
48+
49+
```ini
50+
[wrap-git]
51+
url = https://github.com/fossillogic/fossil-jellyfish.git
52+
revision = v0.1.4
53+
54+
[provide]
55+
dependency_names = fossil-jellyfish
56+
```
57+
58+
**Note**: For the best experience, always use the latest releases. Visit the [releases](https://github.com/fossillogic/fossil-jellyfish/releases) page for the latest versions.
6259

6360
## Configure Options
6461

0 commit comments

Comments
 (0)