Changeset 1195 for framspy/README.txt

Timestamp:

02/01/23 22:58:25 (2 years ago)

Author:

Maciej Komosinski

Message:

Cosmetic

File:

• framspy/README.txt (modified) (1 diff)

framspy/README.txt ¶

@@ -5 +5 @@
 
 "frams.py" is the most fundamental file. It allows to access Framsticks script
-objects in Python. You will find detailed descriptions in the source of this file.
+objects in Python. You will find detailed descriptions in the source of this file,
+but since this file is only responsible for buidling the low-level bridge between
+Framsticks and Python, understanding and modifying it should not be necessary.
 
 "frams-test.py" uses "frams.py" and tests the connection between Python
 and the native Framsticks library by performing a number of simple yet diversified
-operations,  so you should run it first to ensure everything works correctly. 
+operations, so you should run it first to ensure everything works correctly.
+This file can also be treated as a set of examples and demonstrations on how to access
+Framsticks genotypes, the simulation, body parts, neurons, etc.
 Again, read the comments in the source for more information.
 
-"FramsticksLib.py" uses "frams.py" and provides a few fundamental building blocks
+"FramsticksLib.py" uses "frams.py" and provides a few fundamental, high-level building blocks
 for optimization: functions to mutate, crossover, evaluate a solution, etc.