-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
12 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,16 @@ | ||
# CLIc | ||
|
||
[![Build & test](https://github.com/clEsperanto/CLIc_prototype/actions/workflows/build-test.yml/badge.svg)](https://github.com/clEsperanto/CLIc_prototype/actions/workflows/build-test.yml) | ||
[![CI-Tests](https://github.com/clEsperanto/CLIc_prototype/actions/workflows/tests_and_coverage.yml/badge.svg)](https://github.com/clEsperanto/CLIc_prototype/actions/workflows/tests_and_coverage.yml) | ||
[![Codecov](https://codecov.io/gh/clEsperanto/CLIc_prototype/branch/master/graph/badge.svg?token=QRSZHYDFIF)](https://codecov.io/gh/clEsperanto/CLIc_prototype) | ||
[![License](https://img.shields.io/badge/license-BSD-informational)](https://github.com/clEsperanto/CLIc_prototype/blob/master/LICENSE) | ||
[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/clesperanto/CLIc_prototype?color=white&include_prereleases)](https://github.com/clEsperanto/CLIc_prototype/releases/latest) | ||
[![Build & test](https://github.com/clEsperanto/CLIc/actions/workflows/build-test.yml/badge.svg)](https://github.com/clEsperanto/CLIc/actions/workflows/build-test.yml) | ||
[![CI-Tests](https://github.com/clEsperanto/CLIc/actions/workflows/tests_and_coverage.yml/badge.svg)](https://github.com/clEsperanto/CLIc/actions/workflows/tests_and_coverage.yml) | ||
[![Codecov](https://codecov.io/gh/clEsperanto/CLIc/branch/master/graph/badge.svg?token=QRSZHYDFIF)](https://codecov.io/gh/clEsperanto/CLIc) | ||
[![License](https://img.shields.io/badge/license-BSD-informational)](https://github.com/clEsperanto/CLIc/blob/master/LICENSE) | ||
[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/clesperanto/CLIc?color=white&include_prereleases)](https://github.com/clEsperanto/CLIc/releases/latest) | ||
[![CppStd](https://img.shields.io/badge/cpp--std-c%2B%2B17-blue)](https://en.cppreference.com/w/cpp/17) | ||
[![OpenCL](https://img.shields.io/badge/OpenCL-3.0-green)](https://www.khronos.org/opencl/) | ||
[![Website](https://img.shields.io/website?url=http%3A%2F%2Fclesperanto.net)](http://clesperanto.net) | ||
[![GitHub issues](https://img.shields.io/github/issues-raw/clEsperanto/CLIc_prototype)](https://github.com/clEsperanto/CLIc_prototype/issues) | ||
[![GitHub stars](https://img.shields.io/github/stars/clEsperanto/CLIc_prototype?style=social)](https://github.com/clEsperanto/CLIc_prototype) | ||
[![GitHub forks](https://img.shields.io/github/forks/clEsperanto/CLIc_prototype?style=social)](https://github.com/clEsperanto/CLIc_prototype) | ||
[![GitHub issues](https://img.shields.io/github/issues-raw/clEsperanto/CLIc)](https://github.com/clEsperanto/CLIc/issues) | ||
[![GitHub stars](https://img.shields.io/github/stars/clEsperanto/CLIc?style=social)](https://github.com/clEsperanto/CLIc) | ||
[![GitHub forks](https://img.shields.io/github/forks/clEsperanto/CLIc?style=social)](https://github.com/clEsperanto/CLIc) | ||
|
||
CLIc is a **prototype** backend library for [CLesperanto](https://github.com/clEsperanto) - a multi-language framework for GPU-accelerated image processing. It uses the [OpenCL kernels](https://github.com/clEsperanto/clij-opencl-kernels/tree/development/src/main/java/net/haesleinhuepf/clij/kernels) from [CLIJ](https://clij.github.io/) | ||
|
||
|
@@ -58,8 +58,8 @@ Follow the [installation guide](./docs/guidelines.md) for helps on compilation a | |
Clone the repository and update the submodules | ||
``` | ||
git clone [email protected]:clEsperanto/CLIc_prototype.git | ||
cd CLIc_prototype | ||
git clone [email protected]:clEsperanto/CLIc.git | ||
cd CLIc | ||
``` | ||
Create a build folder and configure cmake to generate the adapted makefile. | ||
|
@@ -80,12 +80,12 @@ cmake --build ./build --target uninstall | |
CLIc filters rely on the clEsperanto branch of [CLIj OpenCL kernels](https://github.com/clEsperanto/clij-opencl-kernels). They are managed as a submodule of this repository. | ||
# __Contributing__ | ||
Contributions are very welcome. Before spending effort on coding and filing a pull-request, please get in touch with us, [file an issue](https://github.com/clEsperanto/CLIc_prototype/issues), and let's discuss your potential contribution. | ||
Contributions are very welcome. Before spending effort on coding and filing a pull-request, please get in touch with us, [file an issue](https://github.com/clEsperanto/CLIc/issues), and let's discuss your potential contribution. | ||
More information on how to add new kernels to the library can be found in the [documentation](./docs/add_new_kernel/add_new_kernel.md). | ||
# __Feedback welcome!__ | ||
clEsperanto is developed in the open because we believe in the [open source community](https://clij.github.io/clij2-docs/community_guidelines). | ||
Feel free to drop feedback as [github issue](https://github.com/clEsperanto/CLIc_prototype/issues) or via [image.sc](https://image.sc). | ||
Feel free to drop feedback as [github issue](https://github.com/clEsperanto/CLIc/issues) or via [image.sc](https://image.sc). | ||
And if you liked our work, star the repository, share it with your friends, and use it to make cool stuff! | ||
## Acknowledgements | ||
|