diff --git a/README.md b/README.md index afade7d..3307e1f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,47 @@ # Command-Line-Radio -A radio-like chat system for use on local networks \ No newline at end of file +A radio-like chat system for use on local networks. Verison A-1 + +

Introduction

+ +Ever wanted a mini text radio across your local network? Well, here it is! + +CLRadio is a radio program that can transmit one-way text messages (as of now) to another computer, regardless of distance, as long as they are connected to the same network. It is pretty intuitive to use. + +

Usage

+ +1. Start the server program before starting the client. + +2. Obtain the ipv4 address through running `ipconfig` in cmd/powershell + +3. Create a profile in the client + +``` +================================================================================ +CLRadio Sender Version A-1 | by P7MJ +-------------------------------------------------------------------------------- +[1] Use/Edit saved ports +[2] Specify port + > +``` + +Insert 1 and press Enter, then you will see: + +``` +Current Saved Profiles: +: + +[1] Write new profile entry +[2] Select a profile +[3] Clear all profiles (IRREVERSIBLE, WILL ANNIHILATE MASSDEBATER67'S BRAIN) + > +``` +Select a profile, if it exists, using the position at which it is in the list (1 for first entry, 2 for second...), create a new one, or delete all of them. + +4. The client will connect to that profile and a connection will be initialized if a server at that IP exists. + +

Known Errors/Future development directions

+ +- You must start the server first in order to connect with the client. + +- The client is now one-way. The server is recieve-only, much like non-commander variants of the T-34 in WW2. \ No newline at end of file