Skip to content
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

Jump to bottom

Update README #69

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README #69

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
13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# revengeMusic

Written in C++
Written in C++11

A command line music program for linux,
Designed not to play two tracks at once and to be easily used in shell programs, this way key shortcuts and option flags
could allow a user to find a creative uses, I intend to release a gui mode and sound file search and create a music program with
similar implementation to rofi.
A command line music program for Windows/Linux.
Inter-process communication [(IPC)](https://en.wikipedia.org/wiki/Inter-process_communication) is utilized to ensure only one instance of revengeMusic is used at a time. When a second instance of revengeMusic is launched (Client), it's used to command the first instance (Player). Designed for use with shell, it enables the user to find creative uses by combining shortcut keys and program arguments.

best case scenario is to mod rofi to play music files
Inspired by rofi; one of the goals is to work seamlessly with rofi.

# Building
## Dependencies
Expand All @@ -16,7 +14,8 @@ best case scenario is to mod rofi to play music files
- Install the 'low level' headers to `/usr/include/fmodex/`
- Install the 'low level' libraries to `/usr/lib/`
- **For Windows**
- FMOD has it's own installer, nothing needs to be done manually
- FMOD has its own installer, nothing needs to be done manually
- [Boost 1.58.0](http://www.boost.org/users/download/)
- [CMake 3.4](https://cmake.org/download/) (recommended)

## Compiling
Expand Down