Skip to content

Commit

Permalink
[ADD] documentation link to readme (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
mhorn11 committed Jan 2, 2024
1 parent 64eb8e9 commit 6baa8ec
Showing 1 changed file with 3 additions and 15 deletions.
18 changes: 3 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,11 @@ We provide various solving and optimization methods for different calibration fo
* Hand-eye robot-world calibration


## Installation

Clone the repository and run the following command in your Python environment:

```bash
python3 -m pip install .
```

This command should automatically install Excalibur and all requirements.
If the installation fails, first make sure that pip is updated to the latest version.

Supported Python versions: `3.8`, `3.9`, `3.10`


## Documentation

The `doc` directory provides a detailed readme on how to create the documentation directly from the repository.
For installation instructions and the basic usage, see the documentation at [excalibur-mrm.readthedocs.io](https://excalibur-mrm.readthedocs.io).

Furthermore, the `doc` directory provides a detailed readme on how to create the documentation directly from the repository.


## Publications
Expand Down

0 comments on commit 6baa8ec

Please sign in to comment.