Skip to content

Commit 099eff0

Browse files
committed
Update README.md
1 parent d734c2f commit 099eff0

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
1-
# GeoComPy
1+
<h1 align="center">
2+
<img src="https://raw.githubusercontent.com/mrclock8163/geocompy/main/docs/geocompy_logo.png" alt="GeoComPy logo" width="300">
3+
</h1><br>
4+
5+
[![PyPI - Version](https://img.shields.io/pypi/v/geocompy)](https://pypi.org/project/geocompy/)
6+
[![Python Version](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FMrClock8163%2FGeoComPy%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)](https://pypi.org/project/geocompy/)
7+
[![GPLv3](https://img.shields.io/github/license/mrclock8163/geocompy)](https://www.gnu.org/licenses/gpl-3.0.html)
8+
[![Tests status](https://img.shields.io/github/actions/workflow/status/mrclock8163/geocompy/run-tests.yml?label=tests)](https://github.com/MrClock8163/GeoComPy)
9+
[![Docs status](https://app.readthedocs.org/projects/geocompy/badge/?version=latest)](https://geocompy.readthedocs.io/latest/)
10+
[![Typed](https://img.shields.io/pypi/types/geocompy)](https://pypi.org/project/geocompy/)
211

312
GeoComPy is a Python library providing wrapper functions for serial
413
communication protocols of Leica surveying instruments.
@@ -7,3 +16,23 @@ The package is mainly built around the GeoCom ASCII protocol, supported by
716
a number of total stations and other instruments running TPS1000, 1100, 1200
817
and other firmware. For some older instruments that do not support GeoCom,
918
the GSI Online command set is used for communication.
19+
20+
- **Download:** https://pypi.org/project/geocompy/
21+
- **Documentation:** https://geocompy.readthedocs.io/
22+
- **Source:** https://github.com/MrClock8163/GeoComPy
23+
- **Bug reports:** https://github.com/MrClock8163/GeoComPy/issues
24+
25+
## Main features
26+
27+
- Pure Python implementation
28+
- Support for type checkers
29+
- Primitives for relevant data
30+
- Command building and parsing through function calls
31+
- Multiple supported protocols (e.g. GeoCom, GSI Online)
32+
33+
## Requirements
34+
35+
To use the package, Python 3.11 or higher is required.
36+
For the platform independent serial communication, GeoComPy relies on the
37+
[pySerial](https://pypi.org/project/pyserial/) package to provide the
38+
necessary abstractions.

0 commit comments

Comments
 (0)