Update README and bump version for v1.4.0 release
[tetris.git] / README.md
blobe5354f2816ec7bc0fe49ad87e115ea18fbc97b08
1 <img align="right" src="micro-tetris-color.png" alt="Micro Tetris in Action">
3 Micro Tetris™
4 =============
6 Micro Tetris™ — one of the smallest Tetris implementations in the world!
7 Utilizing only ANSI escape sequences to draw the board, no external
8 library dependencies other than a standard C library, like [uClibc][] or
9 [musl libc][]. Hence, very suitable for embedded devices in need of an
10 easter egg ;-)
12 Issue tracker and GIT repository available at GitHub:
14   * [Repository][]
15   * [Issue Tracker][]
16   * [Docker Image](https://ghcr.io/troglobit/tetris)
17   * [tetris-1.4.0.tar.gz][tarball], [MD5][], [SHA256][]
20 Docker Image
21 ------------
23 Pre-built Docker images are available from [ghcr.io][] as of the v1.4.0
24 release.  Previous releases available on <https://hub.dockercom>.  The
25 [GIT repository][repository] has a `Dockerfile` for building your own
26 image from the source tree:
28 ```shell
29 cd tetris/
30 docker build -t troglobit:tetris .
34 docker run -ti troglobit:tetris
35 ```
37 > These instructions assume you already have [docker.io][] installed.
40 Origin & References
41 -------------------
43 The game is based on a 1989 *International Obfuscated C Code Contest*
44 ([IOCCC](http://www.ioccc.org)) entry made by [John Tromp][].  See
45 John's home page for the source code http://tromp.github.io/tetris.html
47 This human-readable "clone" is maintained by [Joachim Wiberg][].
49 [uClibc]:          https://uclibc-ng.org
50 [ghcr.io]:         https://github.com/troglobit/tetris/pkgs/container/tetris/
51 [musl libc]:       https://www.musl-libc.org
52 [docker.io]:       https://www.docker.com
53 [John Tromp]:      https://tromp.github.io/
54 [Repository]:      https://github.com/troglobit/tetris
55 [Issue Tracker]:   https://github.com/troglobit/tetris/issues
56 [Joachim Wiberg]:  https://troglobit.com
57 [tarball]:         https://ftp.troglobit.com/tetris/tetris-1.4.0.tar.gz
58 [MD5]:             https://ftp.troglobit.com/tetris/tetris-1.4.0.tar.gz.md5
59 [SHA256]:          https://ftp.troglobit.com/tetris/tetris-1.4.0.tar.gz.sha256