Adds better documentation around submodules

Bug #213
pull/242/head
Tpt 2 years ago committed by Thomas Tanon
parent 1d7208ea5a
commit f3e138f0b4
  1. 9
      README.md
  2. 3
      lib/README.md
  3. 2
      python/README.md
  4. 2
      server/README.md

@ -39,13 +39,10 @@ Oxigraph implements the following specifications:
A preliminary benchmark [is provided](bench/README.md). There is also [a document describing Oxigraph technical architecture](https://github.com/oxigraph/oxigraph/wiki/Architecture).
## Development
When cloning this codebase, don't forget to clone the submodules using
`git clone --recursive https://github.com/oxigraph/oxigraph.git` to clone the repository including submodules or
`git submodule update --init` to add the submodules to the already cloned repository.
The easiest way to set up the development environment is to use Visual Studio Code's [development containers](https://code.visualstudio.com/docs/remote/containers). Note that this requires Docker Desktop on Windows and Mac and Docker CE/EE on Linux.
Open the repository with Visual Studio Code and use the Command Palette to run `Remote-Containers: Rebuild Container`. This will re-open the project inside a development container with the Rust toolchain and Python dependencies installed. For more details on how the development container is set up, see [.devcontainer/devcontainer.json](.devcontainer/devcontainer.json) and [.devcontainer/Dockerfile](.devcontainer/Dockerfile).
For further development details, see the README in each of the respective sub-projects.
## Help

@ -52,6 +52,9 @@ Some parts of this library are available as standalone crates:
* [`spargebra`](https://crates.io/crates/spargebra) provides a SPARQL parser.
* [`sparesults`](https://crates.io/crates/sparesults) provides parsers and serializers for SPARQL result formats.
To build the library, don't forget to clone the submodules using `git clone --recursive https://github.com/oxigraph/oxigraph.git` to clone the repository including submodules or `git submodule update --init` to add submodules to the already cloned repository.
## License
This project is licensed under either of

@ -28,7 +28,7 @@ Pyoxigraph documentation is [available on the Oxigraph website](https://oxigraph
## Build the development version
To build and install the development version of pyoxigraph you need to clone this git repository
To build and install the development version of pyoxigraph you need to clone this git repository including submodules (`git clone --recursive https://github.com/oxigraph/oxigraph.git`)
and to run `pip install .` in the `python` directory (the one this README is in).
## Help

@ -39,7 +39,7 @@ You need to have [a recent stable version of Rust and Cargo installed](https://w
To download, build and install the latest released version run `cargo install oxigraph_server`.
There is no need to clone the git repository.
To compile the server from source, clone this git repository, clone its submodules (`git submodule init && git submodule update`) and execute `cargo build --release` in the `server` directory to compile the full server after having downloaded its dependencies.
To compile the server from source, clone this git repository including its submodules (`git clone --recursive https://github.com/oxigraph/oxigraph.git`), and execute `cargo build --release` in the `server` directory to compile the full server after having downloaded its dependencies.
It will create a fat binary in `target/release/oxigraph_server`.
## Usage

Loading…
Cancel
Save