diff --git a/README.md b/README.md index 9f272ba..16d5437 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -This package contains simplified MD code with multi-threading +This repository contains simplified MD codes with multi-threading parallelization for simulating atoms with a Lennard-Jones potential. -The bundled makefiles are set up to compile the executable once -with OpenMP disabled and once with OpenMP enabled with each build +The bundled makefiles are set up to compile the executable ,once +with OpenMP "disabled" and once with OpenMP "enabled", with each build placing the various object files in separate directories. -The examples directory contains 3 sets of example input decks -and the reference directory the corresponding outputs. +The examples directory contains 3 sets of example-input-decks +and the reference directory contains the corresponding outputs. -Type: make -to compile everything and: make clean -to remove all compiled objects +Type: +make - to compile everything +make clean - to remove all compiled objects