commit baa19de2f355f4b3dab1008ac56ffe22abf42523
parent aae695b7e274c999ca1da85e181df7db7638cb3e
Author: Pablo Cárdenas <pablo.cardenas@imca.edu.pe>
Date: Mon, 24 Jun 2024 16:24:57 -0500
Added README.md and LICENSE
Diffstat:
2 files changed, 41 insertions(+), 0 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,6 @@
+Copyright 2024 Pablo Cárdenas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,35 @@
+# tt
+
+`tt` is a terminal-based typing game.
+
+## Features
+
+- **Read ahead**: Hides the current texts and highlight the following.
+- **Network Play**: Connect with friends over a network using sockets.
+
+## Installation
+
+```sh
+git clone https://github.com/pablo-cardenas/tt.git
+cd tt
+make
+sudo make install
+```
+
+## Usage
+
+First, run the server
+
+```sh
+./ttsrv <port> <json>
+```
+
+The, run the client:
+
+```sh
+./ttcli <host> <port>
+```
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
