Skip to content

Adds tested IDEs section to README.md #56

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.

Sign up for GitHub

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

Merged
dllargent merged 1 commit into from
Nov 6, 2025
Merged

Adds tested IDEs section to README.md #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ Thank you to everyone who has contributed to this library.
- Santos Pena

## Dependencies
MediaComp is strongly dependent on several libraries. Most of the these will install with the package, ***however*** Windows users will need to download and install the Visual Studio Build Tools for C/C++ development (see documentation).
MediaComp is strongly dependent on several libraries. Most of the these will install with the package, ***however*** to make sure you get wxPython with the package, install it with
```pip install mediaComp[gui]```.

| Dependency | Version |
| :-----:| :-----: |
Expand All @@ -40,5 +41,9 @@ MediaComp is strongly dependent on several libraries. Most of the these will ins
| numpy | >= 2.2.1 |
| sounddevice | >= 0.5.2 |

## Tested IDEs

MediaComp is primarily used in the [Thonny IDE](https://thonny.org/), but has been used in [VSCode](https://code.visualstudio.com/) and [JetBrains PyCharm](https://www.jetbrains.com/pycharm/) as well. If you encounter an issue using any of the three IDE's, [submit an issue](https://github.com/dllargent/mediaComp/issues)!

## License
This package is distributed under GPL 3.0-or-later, which can be found in our GitHub repository in ```LICENSE```. This means you can basically use mediaComp in any project you want. Any changes or additions made the package must also be released with a compatible license.