Merge pull request #9 from ninedraft/use-named-main-pkg

Use named main pkg

README.md

@@ -1,4 +1,5 @@
 # Chronos
+
 <p align="center">
     <img src="https://i.imgur.com/AhLyxVh.jpeg" width="150" height="225">
 </p>
@@ -12,58 +13,67 @@
 Chronos is a static race detector for the Go language written in Go.
 
 ## Quick Start:
+
 Download the package
+
 ```
-go get -u -v github.com/amit-davidson/Chronos
-```
-Compile the program
-```
-cd cmd && go build -o chronos
+go get -v github.com/amit-davidson/Chronos/cmd/chronos
 ```
 
 Pass the entry point
+
 ```
 chronos --file <path_to_main>
 ```
 
 Help
+
 ```
 Usage of ./chronos:
   -file string
     	The file containing the entry point of the program
   -pkg string
     	Path to the to pkg of the file. Tells Chronos where to perform the search. By default, it assumes the file is inside $GOPATH
 ```
+
 ## Example:
+
 <p float="left">
     <img src="https://i.imgur.com/LJMP9c2.png" width="245" height="300">
     <img src="https://i.imgur.com/S2mDG7A.png" width="575" height="300">
 </p>
 
 ## Features:
+
 Support:
+
 - Detects races on pointers passed around the program.
 - Analysis of conditional branches, nested functions, interfaces, and defers.
 - Synchronization using mutex and goroutines starts.
 
 Limitations:
+
 - Big programs and external packages. (Due to stack overflow)
 - Analysis of panics, for loops, goto, recursion, and select.
 - Synchronization using channels, waitgroups, once, cond and atomic.
 
 ## Chronos vs go race:
+
 Chronos successfully reports cases where go race fails thanks to his static nature. Mostly because data races appear in unexpected production workloads, which are hard to produce in dev.
 In addition, go race is having trouble with short programs where without contrived synchronization the program may exit too quickly.
- 
-In contrast, Chronos managed to report only 244/403 = 60.5% of go race test cases. This can be explained by Chronos partial support with Go's features so this number will increase in the future. 
+
+In contrast, Chronos managed to report only 244/403 = 60.5% of go race test cases. This can be explained by Chronos partial support with Go's features so this number will increase in the future.
 Also, it lacked due to his static nature where context/path/flow sensitivity was required.
 
 Therefore, I suggest using both according the strengths and weaknesses of each of the race detectors.
+
 ## Credits:
+
 Jan Wen, J., Jhala, R., &amp; Lerner, S. (n.d.). [RELAY: Static Race Detection on Millions of Lines of Code](https://cseweb.ucsd.edu/~lerner/papers/relay.pdf)  
 Colin J. Fidge (February 1988). [Timestamps in Message-Passing Systems That Preserve the Partial Ordering"](http://zoo.cs.yale.edu/classes/cs426/2012/lab/bib/fidge88timestamps.pdf)
 
 ## More examples:
+
 <p float="left">
     <img src="https://i.imgur.com/NvVWFRf.png" width="230" height="440">
     <img src="https://i.imgur.com/eCNFAX7.png" width=600" height="300">