From e09bf696488b83b090330c1baaf51ec938ed2d3a Mon Sep 17 00:00:00 2001
From: BryanChan777 <43082778+BryanChan777@users.noreply.github.com>
Date: Fri, 22 Nov 2019 19:06:52 -0800
Subject: [PATCH] Update README.md (#1588)

* Update README.md

* python -m unittest -v
---
 linear_algebra/README.md | 18 +++++++-----------
 1 file changed, 7 insertions(+), 11 deletions(-)

diff --git a/linear_algebra/README.md b/linear_algebra/README.md
index 169cd074d..540920744 100644
--- a/linear_algebra/README.md
+++ b/linear_algebra/README.md
@@ -1,6 +1,6 @@
 # Linear algebra library for Python  
 
-This module contains some useful classes and functions for dealing with linear algebra in python 2.  
+This module contains classes and functions for doing linear algebra.  
 
 ---
 
@@ -8,7 +8,7 @@ This module contains some useful classes and functions for dealing with linear a
 
 ### class Vector  
 -
-    - This class represents a vector of arbitray size and operations on it.  
+    - This class represents a vector of arbitray size and related operations.  
 
     **Overview about the methods:**    
         
@@ -58,22 +58,18 @@ This module contains some useful classes and functions for dealing with linear a
 
 ## Documentation  
 
-The module is well documented. You can use the python in-built ```help(...)``` function.  
-For instance: ```help(Vector)``` gives you all information about the Vector-class.  
-Or ```help(unitBasisVector)``` gives you all information you needed about the  
-global function ```unitBasisVector(...)```. If you need informations about a certain  
-method you type ```help(CLASSNAME.METHODNAME)```.  
+This module uses docstrings to enable the use of Python's in-built `help(...)` function.
+For instance, try `help(Vector)`, `help(unitBasisVector)`, and `help(CLASSNAME.METHODNAME)`.
 
 ---
 
 ## Usage  
 
-You will find the module in the **src** directory its called ```lib.py```. You need to  
-import this module in your project. Alternative you can also use the file ```lib.pyc``` in python-bytecode.   
+Import the module `lib.py` from the **src** directory into your project.
+Alternatively, you can directly use the Python bytecode file `lib.pyc`.   
 
 ---
 
 ## Tests  
 
-In the **src** directory you also find the test-suite, its called ```tests.py```.  
-The test-suite uses the built-in python-test-framework **unittest**.  
+`src/tests.py` contains Python unit tests which can be run with `python3 -m unittest -v`.