From 7e0079e0a5af2c491f11491049d86d9578992208 Mon Sep 17 00:00:00 2001 From: Nick Leeman Date: Tue, 5 Apr 2022 18:07:44 +0200 Subject: [PATCH] readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b48bd8..f890b70 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # TMSG -Terminal Messaging System \ No newline at end of file +Terminal Messaging System + +### How to use + +1. Download release for your operating system. +2. Put the ``tmsg`` file in a memorable place. +3. Open a terminal in the folder with the ``tmsg`` file, or browse to it using ``cd`` commands +4. Set a username by executing: ``./tmsg --username "usernamehere"`` +5. Send messages by executing: ``./tmsg --msg "type your message here using quotes"`` + +**NOTE:** You only have to do step 4 once. + +**NOTE:** For windows you'll have to excute commands with ``./tmsg.exe ...`` instead of ``./tmsg ...`` \ No newline at end of file