commit e0419effb108769a40f59d7e9d6702add9d8e3f7
parent 579b371ca52b4690b3a2e05bf4d4420212368b97
Author: Jacob R. Edwards <jacobouno@protonmail.com>
Date: Wed, 25 Aug 2021 20:05:21 -0700
Update README
Diffstat:
| M | README | | | 34 | ++++++++++------------------------ |
1 file changed, 10 insertions(+), 24 deletions(-)
diff --git a/README b/README
@@ -1,29 +1,15 @@
ap -- audio player
-The goal for ap to simple to use, simple to understand, and small.
+The ap project consists of a server which manages a list and program.
+In other words, it manage an audio queue and audio player. The
+goal is to be simple to use and have a simple and concise implementation.
Currently it's only simple to use.
-Here are reasons for how it was designed:
+It being a server allows for using external utilities to find music,
+load playlists, or bind keys to various commands and the protocol
+is delimiter based, so humans can easily write directly to the
+server.
-- Why a server
-
- Because I want to bind keys on my keyboard to various
- commands. It also makes using external programs after
- starting the player possible.
-
-- Human readable and writable protocol
-
- It's easy to write clients for and even allows a general
- purpose utility like nc(1) to be used directly with a
- keyboard.
-
-- Dependancies
-
- By using a program to play audio you can choose to use
- ffmpeg or vorbis-tools or whatever.
-
-- Root
-
- For ap, paths are relative to root. Using another directory
- would improve security and bandwidth usage but would make
- it difficult to use tools like find(1).
+Since the name is 'audio player' you might think it plays audio,
+but no, as stated above it manages a list and program and therefor,
+once compiled, it only depends on your audio player of choice.
