-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update readme and contributing #590
Open
f-brinkmann
wants to merge
6
commits into
main
Choose a base branch
from
update/readme
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
749cbc9
Update README.rst
f-brinkmann 127945c
Merge branch 'main' into update/readme
f-brinkmann 5ebaeca
review according to ahms-5
f-brinkmann 61fe783
comments from ahms-5
f-brinkmann a98e8d8
Merge branch 'main' into update/readme
f-brinkmann 45d60b3
Update index.rst
f-brinkmann File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
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 | ||||
---|---|---|---|---|---|---|
|
@@ -10,19 +10,21 @@ pyfar | |||||
.. image:: https://circleci.com/gh/pyfar/pyfar.svg?style=shield | ||||||
:target: https://circleci.com/gh/pyfar/pyfar | ||||||
.. image:: https://mybinder.org/badge_logo.svg | ||||||
:target: https://mybinder.org/v2/gh/pyfar/gallery/main?filepath=docs/gallery | ||||||
:target: https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb | ||||||
|
||||||
|
||||||
The python package for acoustics research (pyfar) offers classes to store | ||||||
audio data, filters, coordinates, and orientations. It also contains common | ||||||
functions for digital audio signal processing. | ||||||
functions for digital audio signal processing and plotting audio signals. | ||||||
|
||||||
Getting Started | ||||||
=============== | ||||||
|
||||||
Check out `pyfar.org`_ for a tour through the pyfar | ||||||
universe, including complete documentation of this package and | ||||||
the other packages. | ||||||
The `pyfar workshop`_ gives an overview of the most important pyfar | ||||||
functionality and is a good starting point. It is part of the | ||||||
`pyfar example gallery`_ that also contains more specific and in-depth | ||||||
examples. The `pyfar documentation`_ gives a detailed and complete | ||||||
overview of pyfar. All these information are available from `pyfar.org`_. | ||||||
|
||||||
Installation | ||||||
============ | ||||||
|
@@ -36,15 +38,18 @@ Use pip to install pyfar | |||||
(Requires Python 3.8 or higher) | ||||||
|
||||||
Audio file reading/writing is supported through `SoundFile`_, which is based on `libsndfile`_. On Windows and OS X, it will be installed automatically. On Linux, you need to install libsndfile using your distribution’s package manager, for example ``sudo apt-get install libsndfile1``. | ||||||
If the installation fails, please check out the `help section`_. | ||||||
|
||||||
Contributing | ||||||
============ | ||||||
|
||||||
Refer to the `contribution guidelines`_ for more information. | ||||||
Check out the `contributing guidelines`_ if you want to become part of pyfar. | ||||||
ahms5 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
|
||||||
.. _contribution guidelines: https://github.com/pyfar/pyfar/blob/develop/CONTRIBUTING.rst | ||||||
.. _pyfar workshop: https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb | ||||||
.. _pyfar example gallery: https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
.. _pyfar documentation: https://pyfar.readthedocs.io | ||||||
.. _pyfar.org: https://pyfar.org | ||||||
.. _read the docs: https://pyfar.readthedocs.io/en/latest | ||||||
.. _SoundFile: https://pysoundfile.readthedocs.io/en/latest/ | ||||||
.. _SoundFile: https://pysoundfile.readthedocs.io | ||||||
.. _libsndfile: http://www.mega-nerd.com/libsndfile/ | ||||||
.. _help section: https://pyfar-gallery.readthedocs.io/en/latest/help | ||||||
.. _contributing guidelines: https://pyfar.readthedocs.io/en/stable/contributing.html |
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 |
---|---|---|
|
@@ -6,7 +6,7 @@ Getting Started | |
=============== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:maxdepth: 1 | ||
|
||
readme | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually prefer the current version. It first links the workshop, which might be the easiest entry to the entrire package and explicitly links the gallery, not only pyfar.org. Would you be fine with leaving it as it is?