usb-screamer

A utility that plays an audio file when a usb device is plugged
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

A utility that plays an audio file when a usb device is plugged

(back to top)

Built With

• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

1. Paplay(Available by default on most linux distros)
2. a usb_audio.ogg file
3. The usb_screamer executable

Installation

1. Download the executable at latest release

2. Add downloaded executable to login scripts

3. Place the usb_audio.ogg file in the same directory as the executable

4. Logout

(back to top)

Usage

Plug in a USB device

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Princewill Olaiya - @codedibia - [email protected]

Project Link: https://github.com/just-nibble/usb-screamer

(back to top)