Skip to content

Commit d40564f

Browse files
committed
docs: remove outdated installation instructions from README
- Removed the section detailing installation from source, including prerequisites and commands. - Streamlined the README to focus on PyPI installation instructions only.
1 parent e4c2ab3 commit d40564f

File tree

1 file changed

+0
-30
lines changed

1 file changed

+0
-30
lines changed

README.md

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -15,36 +15,6 @@ This is a standalone PyPI package that provides a thin `pybind11` wrapper around
1515
python -m pip install -U ark-fbs
1616
```
1717

18-
### Install from source
19-
20-
This repo vendors FlatBuffers source (recommended) and requires an extra header-only
21-
dependency for your FlatBuffers fork.
22-
23-
Prerequisites:
24-
25-
- Python \(\ge\) 3.10
26-
- A C++ toolchain (C++14) + CMake \(\ge\) 3.32
27-
- Git (to fetch submodules)
28-
29-
```bash
30-
git clone --recurse-submodules <your-repo-url>
31-
cd ark_fbs
32-
33-
# Ensure the expected deps exist
34-
# - third_party/flatbuffers/ (git submodule)
35-
# - third_party/nlohmann_json/nlohmann/json.hpp
36-
37-
python -m pip install -U pip
38-
python -m pip install -U build
39-
python -m pip install .
40-
```
41-
42-
If you don't want to use the vendored FlatBuffers source, you can build against a
43-
system/externally provided FlatBuffers by configuring CMake with:
44-
45-
- `ARK_FBS_VENDOR_FLATBUFFERS=OFF` (then `find_package(Flatbuffers REQUIRED)` is used), or
46-
- `ARK_FBS_FLATBUFFERS_SOURCE_DIR=/path/to/flatbuffers` (when vendor mode is ON)
47-
4818
## Repo layout
4919

5020
- `cpp/`: C++ binding source (pybind11)

0 commit comments

Comments
 (0)