Merge pull request twostraws#3 from daveverwer/master

Added simple build and run instructions.
giladronat · Feb 7, 2020 · 0aaccb1 · 0aaccb1
2 parents 63feca1 + d859a9b
commit 0aaccb1
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -26,6 +26,15 @@ Sitrep is built using Apple’s [SwiftSyntax](https://github.com/apple/swift-syn
 
 Sitrep is written using Swift 5.1. You can either build and run the executable directly, or integrate the SitrepCore library into your own code. 
 
+To build Sitrep, clone this repository and open Terminal in the repository root directory. Then run:
+
+```
+swift build
+swift run sitrep ~/path/to/your/project/root
+```
+
+If you would like to keep a copy of the `sitrep` executable around, find it in the `.debug` directory after running `swift build`.
+
 To run Sitrep from the command line just provide it with the name of a project directory to parse – it will locate all Swift files recursively from there. Alternatively, just using `sitrep` by itself will scan the current directory.