Clean up README master
authorJaemin Choi <jchoi157@illinois.edu>
Wed, 20 Sep 2017 20:39:19 +0000 (16:39 -0400)
committerJaemin Choi <jchoi157@illinois.edu>
Wed, 20 Sep 2017 20:39:19 +0000 (16:39 -0400)
README

diff --git a/README b/README
index d2f9263..311a373 100644 (file)
--- a/README
+++ b/README
@@ -1,22 +1,14 @@
-This is a Barnes-Hut simulator written on top of Charm++
+This is a Barnes-Hut simulator written on top of Charm++.
 
 To build:
-       - Edit the Makefile CHARM_PATH to point to your built copy of Charm++ 
-
-       - Edit the Makefile STRUCTURES_PATH to point to the Changa structures library
-               git clone https://github.com/N-BodyShop/utility
-               STRUCTURES_PATH = utility/structures
-
-       - make
+1. Edit the Makefile CHARM_PATH to point to your built copy of Charm++.
+2. Edit the Makefile STRUCTURES_PATH to point to the Changa structures library.
+   git clone https://github.com/N-BodyShop/utility
+   STRUCTURES_PATH = utility/structures
+3. make
 
 Usage:
-
-# Prepare a data file with 10K particles:
-./plummer 10000 particles.bin
-
-# Run on a single processor
-./charmrun +p1 ./barnes -in=particles.bin -p=100  -killat=50
-
-
-
-
+1. Prepare a data file with 10K particles:
+   ./plummer 10000 particles.bin
+2. Run on a single processor with 100 TreePieces and 50 iterations
+   ./charmrun +p1 ./barnes -in=particles.bin -p=100 -killat=50