diff --git a/README.md b/README.md index 352ffc46..fca15aff 100644 --- a/README.md +++ b/README.md @@ -65,20 +65,6 @@ Please ensure you review and adhere to the specific license terms provided with *Please note that all educational and research purposes are considered non-commercial use and it is therefore freely permitted to use BirdNET models in any way.* -## Contribute - -Feel free to clone this repository and contribute to the project. We are always looking for new ideas and improvements. If you have any questions, please don't hesitate to ask. - -Let us know if you have any ideas for new features or improvements or submit a pull request. - -**Help us to improve the documentation!** - -Install `sphinx` and all required themes + plugins with `pip install sphinx sphinx_rtd_theme sphinx-argparse`. - -Run `sphinx-build docs docs/_build`. - -Navigate to `BirdNET-Analyzer/docs/_build` and open `index.html` with a browser of your choice. - ## Funding This project is supported by Jake Holshuh (Cornell class of ยด69) and The Arthur Vining Davis Foundations. diff --git a/docs/contribute.rst b/docs/contribute.rst new file mode 100644 index 00000000..fa0e4d37 --- /dev/null +++ b/docs/contribute.rst @@ -0,0 +1,16 @@ +How To Contibute +================ + +Feel free to clone the `repository `_ and contribute to the project. We are always looking for new ideas and improvements. If you have any questions, please don't hesitate to ask. + +Let us know if you have any ideas for new features or improvements or submit a pull request. + +**Help us to improve the documentation!** + +Install `sphinx` and all required themes + plugins with `pip install sphinx sphinx_rtd_theme sphinx-argparse`. + +Run `sphinx-build docs docs/_build`. + +Navigate to `BirdNET-Analyzer/docs/_build` and open `index.html` with a browser of your choice. + +Make your changes to the `.rst` files in the `docs` directory and submit a pull request. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index a2d7c998..9fca86b0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,6 +15,7 @@ Welcome to the BirdNET-Analyzer documentation! This guide provides detailed info showroom birdnetr birdnet-tiny + contribute Introduction ------------ diff --git a/docs/installation.rst b/docs/installation.rst index 32343d66..383e023c 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -89,10 +89,10 @@ Install the packages If you also want to use the GUI, you need to install the additional packages with: ``pip install .[gui]``. Same goes for server and training tools: ``pip install .[server]`` and ``pip install .[train]``. - Use ``pip install .[gui,server,train]`` to install all packages. + Use ``pip install .[all]`` to install all packages. Verify the installation .. code-block:: bash - python -m birdnet_analyzer.analyze \ No newline at end of file + python -m birdnet_analyzer.analyze \ No newline at end of file