From 1aa98df0246ee75d39abd92be7f54c3000dbce92 Mon Sep 17 00:00:00 2001 From: Tadej Lahovnik Date: Mon, 22 Jul 2024 09:39:20 +0200 Subject: [PATCH] doc: README Table of contents --- README.md | 63 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 39 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 8c4a8c6..527a1b2 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,48 @@

---- +

+Firefly Algorithm --- Implementation of Firefly algorithm in Python +

-# Firefly Algorithm --- Implementation of Firefly algorithm in Python +

+ PyPI Version + PyPI - Python Version + Downloads + GitHub repo size + AUR package + GitHub license + build +

---- +

+ GitHub commit activity + Average time to resolve an issue + Percentage of issues still open + GitHub contributors + Packaging status +

-[![PyPI Version](https://img.shields.io/pypi/v/fireflyalgorithm.svg)](https://pypi.python.org/pypi/fireflyalgorithm) -![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fireflyalgorithm.svg) -![PyPI - Downloads](https://img.shields.io/pypi/dm/fireflyalgorithm.svg) -[![Downloads](https://pepy.tech/badge/fireflyalgorithm)](https://pepy.tech/project/fireflyalgorithm) -![GitHub repo size](https://img.shields.io/github/repo-size/firefly-cpp/FireflyAlgorithm?style=flat-square) -[![AUR package](https://img.shields.io/aur/version/python-fireflyalgorithm?color=blue&label=Arch%20Linux&logo=arch-linux)](https://aur.archlinux.org/packages/python-fireflyalgorithm) -[![GitHub license](https://img.shields.io/github/license/firefly-cpp/FireflyAlgorithm.svg)](https://github.com/firefly-cpp/FireflyAlgorithm/blob/master/LICENSE) -![GitHub commit activity](https://img.shields.io/github/commit-activity/w/firefly-cpp/FireflyAlgorithm.svg) -[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/firefly-cpp/FireflyAlgorithm.svg)](http://isitmaintained.com/project/firefly-cpp/FireflyAlgorithm "Average time to resolve an issue") -[![Percentage of issues still open](http://isitmaintained.com/badge/open/firefly-cpp/FireflyAlgorithm.svg)](http://isitmaintained.com/project/firefly-cpp/FireflyAlgorithm "Percentage of issues still open") -![GitHub contributors](https://img.shields.io/github/contributors/firefly-cpp/FireflyAlgorithm.svg) -[![Packaging status](https://repology.org/badge/tiny-repos/python:fireflyalgorithm.svg)](https://repology.org/project/python:fireflyalgorithm/versions) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10430919.svg)](https://doi.org/10.5281/zenodo.10430919) +

+ DOI +

+ +

+ πŸ“‹ About β€’ + πŸ“¦ Installation β€’ + πŸš€ Usage β€’ + πŸ“š Reference Papers β€’ + πŸ“„ Cite us β€’ + πŸ”‘ License +

-## About πŸ“‹ +## πŸ“‹ About This package implements a nature-inspired algorithm for optimization called Firefly Algorithm (FA) in Python programming language. πŸŒΏπŸ”πŸ’» -## Installation πŸ“¦ +## πŸ“¦ Installation -Install FireflyAlgorithm with pip: +To install FireflyAlgorithm with pip, use: ```sh pip install fireflyalgorithm ``` @@ -40,12 +55,12 @@ To install FireflyAlgorithm on Arch Linux, please use an [AUR helper](https://wi ```sh $ yay -Syyu python-fireflyalgorithm ``` -To install FireflyAlgorithm on Alpine Linux: +To install FireflyAlgorithm on Alpine Linux, use: ```sh $ apk add py3-fireflyalgorithm ``` -## Usage πŸš€ +## πŸš€ Usage ```python from fireflyalgorithm import FireflyAlgorithm @@ -105,18 +120,18 @@ options: **Note:** The CLI script can also run as a python module (python -m fireflyalgorithm ...). -## Reference Papers πŸ“š +## πŸ“š Reference Papers I. Fister Jr., X.-S. Yang, I. Fister, J. Brest. [Memetic firefly algorithm for combinatorial optimization](http://www.iztok-jr-fister.eu/static/publications/44.pdf) in Bioinspired Optimization Methods and their Applications (BIOMA 2012), B. Filipic and J.Silc, Eds. Jozef Stefan Institute, Ljubljana, Slovenia, 2012 I. Fister, I. Fister Jr., X.-S. Yang, J. Brest. [A comprehensive review of firefly algorithms](http://www.iztok-jr-fister.eu/static/publications/23.pdf). Swarm and Evolutionary Computation 13 (2013): 34-46. -## Cite us +## πŸ“„ Cite us Fister Jr., I., Pečnik, L., & Stupan, Ε½. (2023). firefly-cpp/FireflyAlgorithm: 0.4.3 (0.4.3). Zenodo. [https://doi.org/10.5281/zenodo.10430919](https://doi.org/10.5281/zenodo.10430919) -## License +## πŸ”‘ License This package is distributed under the MIT License. This license can be found online at .