Merge branch 'main' into benchmark

nuprl · Aug 30, 2023 · 858785e · 858785e
2 parents 4c56853 + b8ab205
commit 858785e
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 22 deletions.
diff --git a/.github/workflows/Augur.yml b/.github/workflows/Augur.yml
@@ -2,7 +2,7 @@ name: Augur Build Status
 
 on:
   push:
-    branches: [ main ]
+    branches: [ '**' ]
   pull_request:
     branches: [ main ]
 

diff --git a/README.md b/README.md
@@ -24,23 +24,20 @@ Let's walk through how to install Augur and use it to analyze a Node.js project.
 
 First, install Augur's dependencies if you don't already have them: `node`, `npm`, and `docker`.
 
-Clone this project onto your machine:
-```
-$ git clone --recurse-submodules https://github.com/nuprl/augur
-$ cd augur/ts
+Clone this project onto your machine, then build Augur:
 ```
+git clone --recurse-submodules https://github.com/nuprl/augur
+cd augur/ts
 
-Next, build NodeProf and Augur:
-```
-$ ./docker-nodeprof/docker-pull.sh  # Pull NodeProf Docker image
-$ npm install                       # Install Augur deps
-$ npm run build                     # Build Augur
+./docker-nodeprof/docker-pull.sh  # Pull NodeProf Docker image
+npm install                       # Install Augur deps
+npm run build                     # Build Augur
 ```
 
 Try running a basic test to make sure your installation succeeded:
 ```
-$ ./node_modules/.bin/jest -t basic-assignment-tainted
-tainted value flowed into sink {"type":"variable","name":"z","location":{"fileName":"test.js"}}!
+./node_modules/.bin/jest -t basic-assignment-tainted
+# tainted value flowed into sink {"type":"variable","name":"z","location":{"fileName":"test.js"}}!
 ```
 
 Your Augur installation is now set up!
@@ -107,14 +104,14 @@ project/
 
 To analyze this project with Augur, we run:
 ```
-$ cd augur/ts
-$ node ./runner/cli.js ~/project project .
-           #           ^^^^^^^^^ ^^^^^^^ ^
-           #     path to project    |    |
-           #                        |    |
-           #             project name    |
-           #                             |
-           # directory to store temp files
+cd augur/ts
+node ./runner/cli.js --projectDir ~/project --projectName project --outputDir .
+         #           ^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^
+         #     path to project                        |                 |
+         #                                            |                 |
+         #                                      project name            |
+         #                                                              |
+         #                                        directory to store temp files
 ```
 
 Augur will alert us that the application does in fact have the flow we're
@@ -218,7 +215,7 @@ To get the project fully up and running, simply:
 | Variable assignment            |         |             | x    | see #20 |
 | Function call                  |         |             | x    | see #21 |
 | Native functions               |         |             | x    | see #22 |
-| Async/await                    |         | x           |      | see #29 |
+| Async/await                    |         |             | X    | see #29 |
 | Function returns               |         |             | x    | see #30 |
 
 ## Support for Ichnaea Benchmarks
@@ -274,6 +271,6 @@ Continuous integration for Augur was designed and implemented by [Adison Trueblo
 This research was supported by the National Science Foundation under NSF grant 
 CCF-1715153 and REU supplement CCF-1930604.
 
-Copyright (c) 2019-2021 [Programming Research Lab](https://prl.ccs.neu.edu/) at 
+Copyright (c) 2019-2022 [Programming Research Lab](https://prl.ccs.neu.edu/) at 
 Northeastern University. Augur is licensed under the UPL. See the `LICENSE` file
 for more information.