~smlavine/ascii-breakout

968598b13bfe51bb92bbd10ca80bd838b1aa4f0f — Sebastian LaVine 8 months ago 518b1f4
Expand upon README.md

This includes a better introduction, build instructions, copyright info,
and a pointer to the sr.ht project.
1 files changed, 45 insertions(+), 4 deletions(-)

M README.md
M README.md => README.md +45 -4
@@ 1,6 1,47 @@
# ascii-breakout

I wrote this game in 2020 as part of my final portfolio project for AP
Computer Science Principles. I've changed a few things like then, like adding
a license and signal handling, but the core of the game is the same as when
I submitted it.
ascii-breakout is a game inspired by Atari's 1976 classic, _Breakout_.
It uses text-based graphics and can be played in a terminal.

I originally wrote this in 2020 for my final portfolio project in AP
Computer Science Principles, when I was in 11th grade. Since then, I've
sanded off a few rough edges: writing this README, refactoring,
improving documentation, etc.

## Build

To build:
```
git clone https://git.sr.ht/~smlavine/ascii-breakout
cd ascii-breakout
make
```

# Copyright

Copyright (C) 2020-2021 Sebastian LaVine <mail@smlavine.com>.

ascii-breakout is [free software][0], licensed under the terms of
version 3 or later of the GNU General Public License. You can read the
license [here][1], or read a brief synopsis [here][2].

# Libraries

ascii-breakout uses the following libraries:
- [rogueutil](https://github.com/sakhmatd/rogueutil) ([license][3])

# Contributing

To follow the project, see, <https://sr.ht/~smlavine/ascii-breakout>.

To browse the source code repository, see
<https://git.sr.ht/~smlavine/ascii-breakout>.

To send patches, keep up with development, read announcements, and brag
with your high scores, see the mailing list at
<https://lists.sr.ht/~smlavine/ascii-breakout>.

[0]: https://en.wikipedia.org/wiki/free_software
[1]: https://git.sr.ht/~smlavine/ascii-breakout/tree/master/item/LICENSE
[2]: https://choosealicense.com/licenses/gpl-3.0/
[3]: https://git.sr.ht/~smlavine/ascii-breakout/tree/master/item/LICENSE.rogueutil