LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Piotr Pieczywek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,4 @@
-## FibreNet project documentation file
+## FibreNet project documentation
 
 
 ### 1. About this repository
@@ -17,6 +17,12 @@ and angle potentials
 
 When executed code requires an input text file to run the simulations. The input text file contains informations about types of structures used, basic simulation settings, such as size of simulation box, time step, exported data types, definitions of non-bonded interactions etc.. The input file contains also path to model file. Model file is written in plain text format. Model file contains information regarding basic data structures used by simulation software - particles/beads - their initial positions, properties, connectivity.
 
+<img title="Screenshot showing the simulate fibre networks" src="model_example.png">
+Figure 1. Exmples of simulated fibre networks - fibre network under tensile force
+<br/>
+<br/>
+
+
 Presented software is siutable for execution on both GPUs and CPUs. The code architecture was optimized to perform computations using GPUs, while CPU unit manages the host code. This was achieved by including the OpenCL open-source library (Khronos Group, USA). The project was written using the Microsoft Visual Studio Version 16.4.0 (Microsoft Corporation, USA). The host code was written using C++ programming language. It is responsible for managing all OpenCL instructions (managing the data buffers, compiling kernels etc.), reading input files, reading model files, writing all output data, uploading kernels. In the current version of the project all OpenCL kernels are storred in a text file "kernel.cl". This file contains all the necessary definitions of sturctures and functions to perform particle dynamics simulations. The presence of the kernel.cl file in the same directory as the executable is required to run the compiled code.
 >Warning
 There are no guaranties that this software will run on your machine.   
@@ -84,6 +90,10 @@ SPRING [type] [tag] [bead_id_1] [bead_id_2] [rest_length] [stiffness] [failure_s
 ```text
  ANGLE [type] [tag] [bead_id_1] [bead_id_2] [bead_id_3] [spring_id_1] [spring_id_2] [rest_angle] [stiffness]
 
+[type]         - type of angle bond HR - harmonic; HR_FL - harmonic with
+                 failure behaviour
+[tag]          - positive integer value; indicates group membership; used when
+                 properties of selected group are modified;
 [bead_id_1]    - id number of the first bead connected with angular bond;
 [bead_id_2]    - id number of the second bead connected with angular bond;
 [bead_id_3]    - id number of the third bead connected with angular bond;
@@ -665,3 +675,4 @@ along with the file extension and confirming with the enter key.
 
 
 <img title="Screenshot showing the code in action" src="code_run.png">
+Figure 2. Screenshot showing runnig code