diff --git a/README.md b/README.md index 07fe15ac752..372bcc59657 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,81 @@ - Orange -====== +
+ + + +
+ + +# Orange +[Orange] is a data mining and visualization toolbox for novice and expert alike. To explore data with Orange, one requires __no__ programming or in-depth mathematical knowledge. We believe that workflow-based data science tools democratize data science by hiding complex underlying mechanics and exposing intuitive concepts. Anyone who owns data, or is motivated to peek into data, should have the means to do so. + ++ + + +
-[![Discord Chat](https://img.shields.io/discord/633376992607076354?style=for-the-badge&logo=discord&color=orange&labelColor=black)](https://discord.gg/FWrfeXV) -[![build: passing](https://img.shields.io/travis/biolab/orange3?style=for-the-badge&labelColor=black)](https://travis-ci.org/biolab/orange3) -[![codecov](https://img.shields.io/codecov/c/github/biolab/orange3?style=for-the-badge&labelColor=black)](https://codecov.io/gh/biolab/orange3) +[Orange]: https://orange.biolab.si/ -[Orange] is a component-based data mining software. It includes a range of data -visualization, exploration, preprocessing and modeling techniques. It can be -used through a nice and intuitive user interface or, for more advanced users, -as a module for the Python programming language. +## Contributing -This is the latest version of Orange (for Python 3). The deprecated version of Orange 2.7 (for Python 2.7) is still available ([binaries] and [sources]). +[![GitHub Actions](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fbiolab%2Forange3%2Fbadge&label=build)](https://actions-badge.atrox.dev/biolab/orange3/goto) +[![codecov](https://img.shields.io/codecov/c/github/biolab/orange3)](https://codecov.io/gh/biolab/orange3) +[![Contributor count](https://img.shields.io/github/contributors-anon/biolab/orange3)](https://github.com/biolab/orange3/graphs/contributors) +[![Latest GitHub commit](https://img.shields.io/github/last-commit/biolab/orange3)](https://github.com/biolab/orange3/commits/master) -[Orange]: https://orange.biolab.si/ -[binaries]: https://orange.biolab.si/orange2/ -[sources]: https://github.com/biolab/orange2 +Want to get involved? Join us on [![Discord](https://img.shields.io/discord/633376992607076354?logo=discord&color=7389D8&logoColor=white&label=Discord)](https://discord.gg/FWrfeXV), introduce yourself in #general! + +Take a look at our [contributing guide](https://github.com/irgolic/orange3/blob/README-shields/CONTRIBUTING.md), it might answer some questions, and it outlines the standards we adhere to. + +Check out our widget development [![docs](https://readthedocs.org/projects/orange-widget-base/badge/?version=latest)](https://orange-widget-base.readthedocs.io/en/latest/?badge=latest) for a comprehensive guide on writing Orange widgets. + +If you're looking for a good starting point, check out our [![good first issues](https://img.shields.io/github/issues/biolab/orange3/good%20first%20issue?label=good%20first%20issues)](https://github.com/biolab/orange3/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). + + +### The Orange Ecosystem + +The development of Orange is primarily split into three repositories: + +[biolab/orange-canvas-core](https://www.github.com/biolab/orange-canvas-core) implements canvas elements, +[biolab/orange-widget-base](https://www.github.com/biolab/orange-widget-base) implements a widget window's interface elements, +[biolab/orange3](https://www.github.com/biolab/orange3) brings it all together and implements the base data mining toolbox. + +Additionally, add-ons implement additional widgets for more specific use cases. [Anyone can write an add-on.](https://github.com/biolab/orange3-example-addon) Below is a list of our first-party add-ons: + +[biolab/orange3-text](https://www.github.com/biolab/orange3-text) +[biolab/orange3-bioinformatics](https://www.github.com/biolab/orange3-bioinformatics) +[biolab/orange3-timeseries](https://www.github.com/biolab/orange3-timeseries) +[biolab/orange3-single-cell](https://www.github.com/biolab/orange3-single-cell) +[biolab/orange3-imageanalytics](https://www.github.com/biolab/orange3-imageanalytics) +[biolab/orange3-educational](https://www.github.com/biolab/orange3-educational) +[biolab/orange3-geo](https://www.github.com/biolab/orange3-geo) +[biolab/orange3-associate](https://www.github.com/biolab/orange3-associate) +[biolab/orange3-network](https://www.github.com/biolab/orange3-network) + +### Setting up + +1. Set up a __virtual environment__. We recommend [Miniconda](https://docs.conda.io/en/latest/miniconda.html). +`conda create python=3 --name orange3` +2. __Fork__ your chosen repository. +Press the fork button in top-right corner of the page +3. __Clone__ it. +`git clone ssh://git@github.com/