Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ADD] documentation link to readme #5

Merged
merged 1 commit into from
Jan 2, 2024
Merged

[ADD] documentation link to readme #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 3 additions & 15 deletions README.md
View file
Open in desktop
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