Add make options for memory profiling and update README to reflect those additions

.gitignore

@@ -4,5 +4,10 @@
 *.hi
 *.dyn_o
 *.dyn_hi
+*.p_o
+*.aux
+*.hp
+*.prof
+*.ps
 orbit
 OrbitTests

Makefile

@@ -8,8 +8,16 @@ orbit: FORCE
 tests:
 		ghc $(COMPILE_OPTS) Tests.hs -o OrbitTests
 
+prof: distclean
+		ghc $(COMPILE_OPTS) --make Bench.hs -main-is Bench -o orbit && \
+		ghc $(COMPILE_OPTS) --make Bench.hs -main-is Bench -o orbit -prof -osuf p_o
+
+prof-results:
+		hp2ps -e8in -c orbit && \
+		echo "The memory profiling graph is in orbit.ps"
+
 clean:
-		$(RM) *.swp *~ *.hi *.o *.dyn_hi *.dyn_o
+		$(RM) *.swp *~ *.hi *.o *.dyn_hi *.dyn_o *.p_o *.aux *.hp *.prof
 
 distclean: clean
 		$(RM) orbit OrbitTests

README.md

@@ -15,6 +15,34 @@ Required Haskell packages
 - [network-transport-tcp](https://hackage.haskell.org/package/network-transport-tcp)
 - [distributed-process-simplelocalnet](https://hackage.haskell.org/package/distributed-process-simplelocalnet)
 
+Execution
+---------
+
+- Sequential Orbit
+  ```bash
+  ./orbit seq short|intermediate|long host port
+  
+  # Example: executing the 'long' benchmark
+  ./orbit seq long 127.0.0.1 1555
+  ```
+
+Memory Profiling
+----------------
+
+- Compile with enabled profiling
+  ```bash
+  make prof
+  ```
+
+- Run the proper RTS options
+  ```bash
+  # Example: executing the 'long' benchmark
+  ./orbit  +RTS -hd -p -RTS seq long 127.0.0.1 1555
+  ```
+- Prepare the report
+  ```bash
+  make prof-results
+  ```
 
 Credits
 -------