diff --git a/README.md b/README.md index 2b4dc9d..a15043d 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,22 @@ This can be used to study the effect of ## How do I get set up? -1. Clone this repository. -2. Download the conventient tensor manipulation library +1. Clone or download this repository. The best way is to issue + + $ git clone --recurse-submodules https://github.com/abrandberg/indentationToElasticModulus.git + +2. This repository uses the tensor manipulation library MMTensor, originally hosted at Maarten Moesen (2020). MMTensor 1.0 (https://www.mathworks.com/matlabcentral/fileexchange/32891-mmtensor-1-0). -3. Put MMTensor in the path of MATLAB. + + A copy of this repository is hosted on Github (https://github.com/abrandberg/MM_Tensor) and is included as a submodule in this repository. If you cloned the repository without recursively cloning the submodules (step 1) you can initiate the submodules manually by issuing (while standing in the *indentationToElasticModulus* repository) + + $ git submodule init + + $ git submodule update + + This will clone the submodule. + ## Where can I read more about the equations implemented? @@ -58,4 +69,4 @@ If you have a suggestion I propose that you contact me directly and I will try t ## Who do I talk to? -August Brandberg augustbr at k t h . s e. \ No newline at end of file +August Brandberg augustbr at k t h . s e.