Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dchansen06 authored Dec 18, 2024
1 parent b527d38 commit 6857ca3
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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

0 comments on commit 6857ca3

Please # to comment.