Fix install instructions

I realised I had the install instructions for the GUI/Server on the Agent page and for the Agent on the GUI/Server page.
damies13 · Nov 21, 2019 · eaeb396 · eaeb396
1 parent bc4c28b
commit eaeb396
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 23 deletions.
diff --git a/Doc/rfswarm_agent_py.md b/Doc/rfswarm_agent_py.md
@@ -15,27 +15,15 @@ robot -t "test case" script.robot
 
 #### 2. Install the prerequisites
 
-- The Agent machine needs to use a minimum of Python 3.7
-> ThreadingHTTPServer feature of HTTPServer requires was added in Python 3.7
-
-- tkinter may need to be installed
-It may already installed on your system, if not consult the python documentation on how to install for your system.
-
-On Debian based systems this will probably work
-```
-apt install python3-tk
-```
+The Agent machine needs to use a minimum of Python 3.6
+> timespec feature of datetime's isoformat requires Python 3.6+
 
 Additionally the following pip command might be needed if these are not already installed on your system:
 ```
-pip\* install configparser setuptools hashlib HTTPServer pillow
+pip* install configparser requests psutil
 ```
-> setuptools (is required by hashlib and HTTPServer)
-
 \*some systems might need you to use pip3 and or sudo
 
-
-
 #### 3. Run Agent 1st time
 
 ```

diff --git a/Doc/rfswarm_py.md b/Doc/rfswarm_py.md
@@ -3,35 +3,64 @@
 
 ## rfswarm.py (GUI / Server)
 
-rfswarm.py is the GUI and central component of rfswarm, this is where you plan, execute and monitor your performance test.
+rfswarm.py is the GUI and central server component of rfswarm, this is where you plan, execute and monitor your performance test.
+
+- [User Interface](#User-Interface)
+	- [Plan](#Plan)
+	- [Run](#Run)
+	- [Agents](#Agents)
+- [Install and Setup](#Install-and-Setup)
+	- [Install the prerequisites](#1-install-the-prerequisites)
+	- [Run the GUI Server](#2-Run-the-GUI-Server)
+- [Credits](#Credits)
+
+### User Interface
 
 Some screen shots below of rfswarm in action:
-##### Plan - This is where you construct your test scenario, choose your test cases and number of virtual users
+##### Plan
+This is where you construct your test scenario, choose your test cases and number of virtual users
 ![Image](Images/Plan_saved_opened_v0.3.png "Plan - Planning a performance test")
 ![Image](Images/Plan_unsaved_v0.3.png "Plan - New")
-##### Run - This is where you monitor your test scenario as it runs, here you will see number of robots running, how long the has been running and live updates of the test results
+##### Run
+This is where you monitor your test scenario as it runs, here you will see number of robots running, how long the has been running and live updates of the test results
 ![Image](Images/Run_Start_v0.3.png "Run - Just Started")
 ![Image](Images/Run_v0.3.png "Run - Showing results being collected live")
-##### Agents - This is where you can see which agents have connected, number of robots on each agent and monitor the performance of the agents
+##### Agents
+This is where you can see which agents have connected, number of robots on each agent and monitor the performance of the agents
 ![Image](Images/Agents_ready_v0.3.png "Agents Ready")
 ![Image](Images/Agents_stopping_v0.3.png "Agents Stopping")
 
 ### Install and Setup
 
 #### 1. Install the prerequisites
 
-The Agent machine needs to use a minimum of Python 3.7
-> timespec feature of datetime's isoformat requires Python 3.6+
+- The GUI/Server machine needs to use a minimum of Python 3.7
+> ThreadingHTTPServer feature of HTTPServer requires was added in Python 3.7
+
+- tkinter may need to be installed
+It may already installed on your system, if not consult the python documentation on how to install for your system.
+
+On Debian based systems this will probably work
+```
+apt install python3-tk
+```
 
 Additionally the following pip command might be needed if these are not already installed on your system:
 ```
-pip\* install configparser requests psutil
+pip* install configparser setuptools hashlib HTTPServer pillow
 ```
+> setuptools (is required by hashlib and HTTPServer)
+
 \*some systems might need you to use pip3 and or sudo
 
+
 #### 2. Run the GUI Server
 
 ```
-python rfswarm.py
+python* rfswarm.py
 ```
 \*or python3 on some systems
+
+### Credits
+
+The icons used for the buttons in the GUI were derived from the Creative Commons licensed (Silk icon set 1.3)[http://www.famfamfam.com/lab/icons/silk/]