From 6857ca312ffb9821913ecd66b9459479d16df771 Mon Sep 17 00:00:00 2001 From: Daniel Hansen <105574022+dchansen06@users.noreply.github.com> Date: Tue, 17 Dec 2024 22:16:10 -0800 Subject: [PATCH] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 94265c7..15ee5af 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [![Build](https://github.com/dchansen06/music-player/actions/workflows/build.yml/badge.svg)](https://github.com/dchansen06/music-player/actions/workflows/build.yml) # music-player -A C++ music player built off of SDL2 for playing and controling music from the terminal +A C++ music player built off of SDL2 for playing and controlling music from the terminal ## License information This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. @@ -24,8 +24,11 @@ Then simply run ```$ make all``` +Use the client and server programs as you would expect, as this is not finalized the runtime instructions are not yet stable, please review the source code for further instructions (sorry). + ## To-Do * Basic GUI functionality +* Better comments (sorry) * Better documentation * Divide into more discrete functions and classes * Setup a testing suite