From 725dcb15822f76339a2c278f4cb85bff4ba3fbd2 Mon Sep 17 00:00:00 2001 From: Steve Kelly Date: Thu, 20 Jul 2023 14:39:19 -0400 Subject: [PATCH] Make it clear that a path is argument to `-c` --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8b9298c..4943290 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,11 @@ There rules are likely to have some false positives and negatives, so feedback w * [Install the Semgrep CLI](https://semgrep.dev/docs/getting-started/) * Clone this repo `git clone https://github.com/JuliaComputing/semgrep-rules-julia.git` -* Run `semgrep -c semgrep-rules-julia /path/to/your/package` +* Run `semgrep -c /path/to/semgrep-rules-julia/ /path/to/your/package` * Semgrep has good [documentation](https://semgrep.dev/docs/) and [tutorials](https://semgrep.dev/learn/), which have more information about the tool. * [Semgrep Playground](https://semgrep.dev/playground/) is the best way to experiment with new rules. ## Contribute -We welcome, and appreciate, new analysis rules. Please open a PR to this repo to add your rule to the ruleset. Rules here should be generally be widely, though not necessarily always, applicable. For each rule in its own `.yaml` file, there should be a corresponding `.jl` file with testcases. \ No newline at end of file +We welcome, and appreciate, new analysis rules. Please open a PR to this repo to add your rule to the ruleset. Rules here should be generally be widely, though not necessarily always, applicable. For each rule in its own `.yaml` file, there should be a corresponding `.jl` file with testcases.