Skip to content

Commit 632a10a

Browse files
committed
reorganize README.md
1 parent 11407bc commit 632a10a

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,22 @@ Supports all compression formats allowed by the RINEX 2 and 3 standards:
77
* Hatanaka compression for Observation Data Files,
88
* LZW (.Z), gzip (.gz), bzip2 (.bz2) and .zip.
99

10-
## Usage
10+
## Quick Start
1111

12-
Usage is simple and straightforward.
12+
### Installation
13+
14+
Wheels are available from PyPI for Linux, MacOS and Windows. Python versions 3.6 and up are supported.
15+
16+
```bash
17+
pip install hatanaka
18+
```
19+
20+
To ensure that everything is working as expected, it is recommended to also run the included tests.
21+
22+
```bash
23+
pip install pytest
24+
pytest --pyargs hatanaka
25+
```
1326

1427
### Python
1528

@@ -57,20 +70,7 @@ rinex-compress 1lsu0010.21o
5770
rinex-decompress < 1lsu0010.21d.Z | grep 'SYS / # / OBS TYPES'
5871
```
5972

60-
## Installation
61-
62-
Wheels are available from PyPI for Linux, MacOS and Windows. Python versions 3.6 and up are supported.
63-
64-
```bash
65-
pip install hatanaka
66-
```
67-
68-
To ensure that everything is working as expected, it is recommended to also run the included tests.
69-
70-
```bash
71-
pip install pytest
72-
pytest --pyargs hatanaka
73-
```
73+
## Development
7474

7575
### Building from source
7676

0 commit comments

Comments
 (0)