chore: add license and readme

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 3D geoinformation group at TU Delft (https://3d.bk.tudelft.nl)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,93 @@
-# point-cloud-collector
+# AHN CLI
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-green.svg)](https://github.com/HideBa/ahn-cli/releases/tag/v0.1.0)
+[![CICD Status: Passing](https://img.shields.io/badge/CICD-Passing-brightgreen.svg)](https://github.com/HideBa/ahn-cli/actions)
+
+## Description
+
+AHN CLI is a command-line interface tool designed for the effortless downloading of AHN (Actueel Hoogtebestand Nederland) point cloud data for specific cities and classification classes.
+
+## Installation
+
+> **NOTE:** AHN CLI requires PDAL to be installed on your system. Follow the installation instructions in the [PDAL documentation](https://pdal.io/download.html) before proceeding.
+
+Install AHN CLI using pip:
+
+```
+pip install ahn_cli
+```
+
+## Usage
+
+To utilize the AHN CLI, execute the following command with the appropriate options:
+
+```shell
+Options:
+ -c, --city <city_name>        Download point cloud data for the specified city.
+ -o, --output <file>           Designate the output file for the downloaded data.
+ -i, --include-class <class>   Include specific point cloud classes in the download,
+                               specified in a comma-separated list. Available classes:
+                               0:Created, never classified; 1:Unclassified; 2:Ground;
+                               6:Building; 9:Water; 14:High tension; 26:Civil structure.
+ -e, --exclude-class <class>   Exclude specific point cloud classes from the download,
+                               specified in a comma-separated list. Available classes as above.
+ -d, --decimate <step>         Decimate the point cloud data by the specified step.
+ -ncc, --no-clip-city          Avoid clipping the point cloud data to the city boundary.
+ -cf, --clip-file <file>       Provide a file path for a clipping boundary file to clip
+                               the point cloud data to a specified area.
+ -r, --radius <radius>         Define a radius (in meters) to clip the point cloud data,
+                               centered on the city polygon.
+ -p, --preview                 Preview the point cloud data in a 3D viewer.
+ -h, --help [category]         Show help information. Optionally specify a category for
+                               detailed help on a specific command.
+ -v, --version                 Display the version number of the AHN CLI and exit.
+```
+
+### Usage Examples
+
+**Download Point Cloud Data for Delft with All Classification Classes:**
+
+```
+ahn_cli -c delft -o ./delft.laz
+```
+
+**To Include or Exclude Specific Classes:**
+
+```
+ahn_cli -c delft -o ./delft.laz -i 1,2
+```
+
+**For Non-Clipped, Rectangular-Shaped Data:**
+
+```
+ahn_cli -c delft -o ./delft.laz -i 1,2 -ncc
+```
+
+**To Decimate City-Scale Point Cloud Data:**
+
+```
+ahn_cli -c delft -o ./delft.laz -i 1,2 -d 2
+```
+
+**Specify a Radius for Clipping:**
+
+If you specify a `radius` (in meters), it will clip the point cloud data from the center of the city polygon to the specified radius.
+
+## Reporting Issues
+
+Encountering issues or bugs? We greatly appreciate your feedback. Please report any problems by opening an issue on our GitHub repository. Be as detailed as possible in your report, including steps to reproduce the issue, the expected outcome, and the actual result. This information will help us address and resolve the issue more efficiently.
+
+## Contributing
+
+Your contributions are welcome! If you're looking to contribute to the AHN CLI project, please first review our Contribution Guidelines. Whether it's fixing bugs, adding new features, or improving documentation, we value your help.
+
+To get started:
+
+- Fork the repository on GitHub.
+- Clone your forked repository to your local machine.
+- Create a new branch for your contribution.
+- Make your changes and commit them with clear, descriptive messages.
+  Push your changes to your fork.
+- Submit a pull request to our repository, providing details about your changes and the value they add to the project.
+- We look forward to reviewing your contributions and potentially merging them into the project!

pyproject.toml

@@ -3,6 +3,7 @@ name = "ahn_cli"
 version = "0.1.0"
 description = ""
 authors = ["HideBa <[email protected]>"]
+license = "MIT"
 readme = "README.md"
 packages = [{ include = "ahn_cli", from = "./" }]
 include = ["ahn_cli/*", "ahn_cli/**/*"]