Skip to content

Commit ba69fd7

Browse files
authored
Update README.md
1 parent 16efc9b commit ba69fd7

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
1-
# Text-Screen-Display
2-
A simple display that you can interface with python. The console model is not required and is used just for the example
1+
# Text Screen Display
2+
A simple display that you can interface with python. The console module is not required and is used just for the example
3+
4+
# Documention
5+
## Initializing a screen
6+
To initizize a screen, you need to use the screen class
7+
`myScreen = screen()`
8+
9+
## Sceen Arguments
10+
When initilizing a screen you have a few argumwnts that you can edit.
11+
12+
1. screen width and height (tuple, required)
13+
14+
--- OR ---
15+
16+
1. screen width (int, required)
17+
2. screen height (int, required)
18+
19+
(always 3rd argument)
20+
21+
3. seporation character (string, optional)
22+
4. empty cell character (string, optional)
23+
5. new line character (string, optional)
24+
6. Data to screen (dictonary, optional)
25+
7. screen data (matrix, optional) (putting something in this argument will automatically display it)
26+
27+
*I know this documentation sucks.* **Please help improvw my docs on this**

0 commit comments

Comments
 (0)