Skip to content

Commit ab13f30

Browse files
committed
updated README
1 parent 179999e commit ab13f30

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,16 @@ For convenience, the default user name, nickname, and 'real' name sent to the IR
5454
The main entry point is `wiggleVerse.py`. This stub initiates logging, creates a Client object, and waits for a quit signal from the Client to cleanly close. It also uses the curses wrapper to easily set up and tear down the `curses` library for terminal interactivity
5555

5656
From here on, the following classes are used:
57-
* Client - Initializes a Screen, IRC, Settings, CommandParser, and ServerParser class. Controls the whole show!
58-
* CommandParser - Parses the commands that the user types
59-
* Exceptions - Common file that defines some custom exceptions
60-
* IRC - Controls the connection to an IRC network
61-
* IRCSocket - Handles some lower level implementation details
62-
* Screen - Handles all input and output on the terminal
63-
* Settings - Controls setting, reading, and saving of user settings
64-
* ServerParser - Formats incoming messages from the IRC server
57+
```
58+
Client - Initializes a Screen, IRC, Settings, CommandParser, and ServerParser class. Controls the whole show!
59+
CommandParser - Parses the commands that the user types
60+
Exceptions - Common file that defines some custom exceptions
61+
IRC - Controls the connection to an IRC network
62+
IRCSocket - Handles some lower level implementation details
63+
Screen - Handles all input and output on the terminal
64+
Settings - Controls setting, reading, and saving of user settings
65+
ServerParser - Formats incoming messages from the IRC server
66+
```
6567

6668
As of current, too much functionality is in the Client class. A future refactor would move more of it to the IRC class. This would be greatly helpful before trying to implement multiple server support.
6769

0 commit comments

Comments
 (0)