# n.cv.h

**Repository Path**: neur1n/n.cv.h

## Basic Information

- **Project Name**: n.cv.h
- **Description**: Some C++ utilities for computer vision.
- **Primary Language**: C++
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-24
- **Last Updated**: 2024-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!------------------------------------------------------------------ HEADER -->
<pre align="center">
  ▄▀▀▀▀▄▀▀▄    ▄▀▀▀▀▀▀▀▄ █▀▀▀█▀▀▀█    █▀▀▀█▀▀▀█
  █    █  █    █   ▄▄  █ █   █   █    █   █   █
  █  █ █  █    █   █████ █   █   █    █       █
  █  █    █    █   ▀▀  █  ▀▄   ▄▀     █   █   █
  ▀▄▄▀▄▄▄▄▀ ██ ▀▄▄▄▄▄▄▄▀    ▀▄▀    ██ █▄▄▄█▄▄▄█
</pre>


<p align="center">
  <img src="https://img.shields.io/badge/C++11-00599C?style=for-the-badge&logo=c%2B%2B&logoColor=white" alt="C++11">

  <a href="./LICENSE">
    <img src="https://img.shields.io/badge/license-mit-green.svg?style=for-the-badge" alt="license-mit">
  </a>
</p>

<p align="center">
  Some C++ utilities for computer vision.
</p>


<!------------------------------------------------------- TABLE OF CONTENTS -->
<details open="open">
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#documentation">Documentation</a>
    </li>
    <li><a href="#license">License</a></li>
  </ol>
</details>


<!--------------------------------------------------------- GETTING STARTED -->
## Getting Started
### Prerequisites
These are tested prerequisites, they might be not mandatory:
- C++ compiler: >= C++11
- Eigen (optional): >= 3.3.7


### Installation
For end users, it is recommended to grab the file ('n.cv.h' for C++,
'n_cv.py' for Python) and drop it into your project. For contributors,
you may want to clone the entire repository for testing purpose:

```bash
git clone https://github.com/Neur1n/n.cv.h.git
```


<!------------------------------------------------------------------- USAGE -->
## Usage
For CMake users, download and put `n.cv.h` into your project and add a line
to to `INCLUDE_DIRECTORIES()` in your project's main `CMakeLists.txt`:

```cmake
INCLUDE_DIRECTORIES(
  path/to/directory/containing/n.cv.h
)
```

Additionally, add some dependency configurations required by `n.cv.h` to
`CMakeLists.txt` (you may refer to the `test/CMakeLists.txt` in this repository).


<!----------------------------------------------------------- DOCUMENTATION -->
## Documentation
TODO


<!----------------------------------------------------------------- LICENSE -->
## License
Distributed under the MIT license. See [LICENSE](LICENSE) for more information.