Skip to content

Commit a95b915

Browse files
committed
Update docs
1 parent 642937c commit a95b915

File tree

3 files changed

+14
-12
lines changed

3 files changed

+14
-12
lines changed

README.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,22 @@
11
<img src="http://raw.github.com/CharmySoft/tic-tac-toe-in-python/master/icons/icon.png" width="48"/>&nbsp;&nbsp;**Tic Tac Toe Online in Python**
22
========================
33
Details of this project can be found on the [Tic Tac Toe project page][2] under:
4-
[*http://www.CharmySoft.com/app/ttt-python.htm*][2]
4+
[*http://chenyumin.com/tic-tac-toe*][2]
55

66
Introduction
77
------------------------
88
[Tic Tac Toe Online in Python][2] is a socket-based Client-Server application in Python that allows multi-players to connect to the server and play Tic Tac Toe online with other players.
99

10-
This project is originally for my Python Assignment in Semester 6 Computer Systems Admin 2.
11-
1210

1311
Manual
1412
------------------------
1513
[Tic Tac Toe Online in Python][2] is a cross-platform game that should work on any modern desktop operating systems. The instructions below are demonstrated on a Linux distro, but you should be able to run this on Windows and Mac OS X as well.
1614

1715
All the Python scripts in this project are written for Python 3.x. The client GUI requires Python Tkinter module. You need to set up the Python 3 environment before you start.
1816

19-
To set up the server, please read [docs/MANUAL-SERVER.md](docs/MANUAL-SERVER.md).
17+
To set up the server, please read [The Server Manual](http://chenyumin.com/p/tic-tac-toe-server-manual) or [docs/MANUAL-SERVER.md](docs/MANUAL-SERVER.md).
2018

21-
To learn about the command-line based client script, please read [docs/MANUAL-CLIENT.md](docs/MANUAL-CLIENT.md).
19+
To learn about the command-line based client script, please read [The Client Manual](http://chenyumin.com/p/tic-tac-toe-client-manual) or [docs/MANUAL-CLIENT.md](docs/MANUAL-CLIENT.md).
2220

2321
To use the client GUI, directly run ttt_client_gui.py with python3.
2422

@@ -46,16 +44,16 @@ Please see the file named [LICENSE.md](LICENSE.md).
4644

4745
Author
4846
------------------------
49-
* Charlie Chen
47+
* [Chen Yumin][3]
5048
founder of [CharmySoft][1]
5149

5250

5351
Contact
5452
------------------------
5553
* CharmySoft: [*http://www.CharmySoft.com/*][1]
56-
* About: [*http://www.CharmySoft.com/about.htm*][3]
57-
* Email: [*Charlie@CharmySoft.com*](mailto:Charlie@CharmySoft.com)
54+
* Chen Yumin: [*http://chenyumin.com*][3]
55+
* Email: [*hello@chenyumin.com*](mailto:hello@chenyumin.com)
5856

5957
[1]: http://www.CharmySoft.com/ "CharmySoft"
60-
[2]: http://www.CharmySoft.com/app/ttt-python.htm "Tic Tac Toe Online in Python"
61-
[3]: http://www.CharmySoft.com/about.htm "About CharmySoft"
58+
[2]: http://chenyumin.com/tic-tac-toe "Tic Tac Toe Online in Python"
59+
[3]: http://chenyumin.com "Chen Yumin"

docs/MANUAL-CLIENT.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Manual for Tic-Tac-Toe Client
1+
Tic-Tac-Toe Client Manual
22
========================
3+
<small>Please read the updated version at [http://chenyumin.com/p/tic-tac-toe-client-manual](http://chenyumin.com/p/tic-tac-toe-client-manual).</small>
4+
35
These are the instructions to use the command-line based Tic-Tac-Toe Client program. For the GUI version, please read [here](../README.md).
46

57
To start the client, run [ttt_client.py](http://github.com/CharmySoft/tic-tac-toe-in-python/raw/master/ttt_client.py) with Python 3:

docs/MANUAL-SERVER.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Manual for Tic-Tac-Toe Server
1+
Tic-Tac-Toe Server Manual
22
========================
3+
<small>Please read the updated version at [The Server Manual](http://chenyumin.com/p/tic-tac-toe-server-manual) or [docs/MANUAL-SERVER.md](docs/MANUAL-SERVER.md).</small>
4+
35
To set up the server, you can run the following shell commands.
46
```bash
57
# Change this to your desired path

0 commit comments

Comments
 (0)