Skip to content

Commit

Permalink
Add a Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
baptisteesteban committed Apr 14, 2024
1 parent b065ab1 commit a8e74fb
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
# Olympus Image Processing Library

[![License: MPL 2.0](https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
![example workflow](https://github.com/baptisteesteban/olympus/actions/workflows/build-and-test.yml/badge.svg)

## Description

The Olympus Image Processing Library is an experimental library implemented in
Rust. My initial objective when starting to build this library was to learn the
Rust programming language by working on a project that would be useful for my
personal experiments. Its design is **strongly** inspired by the
[Pylene](https://gitlab.lre.epita.fr/olena/pylene) image processing library and
follows the same aims. **It has to be noted that this library is entirely developed during my free time, and its progress may be affected by my various other activities.**

Currently, Olympus is not available on the [Rust community's crate
registry](https://crates.io) but it is intended to when it will be mature
enough.

In the case you have some ideas or advices about the library, fell free to fill
an [issue](https://github.com/baptisteesteban/olympus/issues).

0 comments on commit a8e74fb

Please sign in to comment.