Merge pull request #63 from diana-qing/onboarding-docs

thearossman · web-flow · commit 26acb6e1cd63 · 2024-10-15T18:00:27.000-07:00
Add documentation for onboarding steps
diff --git a/INSTALL.md b/INSTALL.md
@@ -157,3 +157,9 @@ meson setup configure -Dplatform=generic
 export LD_LIBRARY_PATH=$DPDK_PATH/lib/aarch64-linux-gnu
 ```
 
+#### Troubleshooting: Mempool Capacity
+When running applications using the provided offline config file, a mempool creation error may occur:
+```sh
+Error: Mempool mempool_0 creation failed
+```
+This can be resolved by reducing the mempool capacity in the config file.
diff --git a/README.md b/README.md
@@ -63,6 +63,7 @@ fn main() {
     runtime.run();
 }
 ```
+Writing a Retina application consists of defining subscriptions. A subscription is defined by (1) [writing a filter](https://stanford-esrg.github.io/retina/retina_filtergen/index.html) to describe what subset of network traffic you're interested in, (2) choosing [data types to subscribe to](https://stanford-esrg.github.io/retina/retina_core/subscription/index.html), and (3) defining a callback function that takes in a subscribable data type and performs operations on the filtered data. 
 
 Build all examples in release mode:
 

Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,7 @@ fn main() {`
`63`	`63`	`runtime.run();`
`64`	`64`	`}`
`65`	`65`	```
	`66`	`+Writing a Retina application consists of defining subscriptions. A subscription is defined by (1) [writing a filter](https://stanford-esrg.github.io/retina/retina_filtergen/index.html) to describe what subset of network traffic you're interested in, (2) choosing [data types to subscribe to](https://stanford-esrg.github.io/retina/retina_core/subscription/index.html), and (3) defining a callback function that takes in a subscribable data type and performs operations on the filtered data.`
`66`	`67`
`67`	`68`	`Build all examples in release mode:`
`68`	`69`