Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
updated compile from source code info
  • Loading branch information
cyclone-github authored Jan 10, 2024
1 parent 66b66e0 commit 74c84aa
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,18 +77,19 @@ More info on RE2: https://github.com/google/re2/wiki/Syntax
| phpass | 400 |

### Compile from source:
- If you want the latest features, compiling from source is the best option since the release version may run several revisions behind the source code.
- This assumes you have Go and Git installed
- `git clone https://github.com/cyclone-github/regx.git`
- `cd regx`
- `go mod init regx`
- `go mod tidy`
- `go build .`
- More info on compiling from source:
- `go build -ldflags="-s -w" .`
- Compile from source code how-to:
- https://github.com/cyclone-github/scripts/blob/main/intro_to_go.txt

### Change Log:
- https://github.com/cyclone-github/regx/blob/main/CHANGELOG.md

### Antivirus False Positives:
- Several antivirus programs on VirusTotal incorrectly detect compiled Go binaries as a false positive. This issue primarily affects the Windows executable binary, but is not limited to it. If this concerns you, I recommend carefully reviewing the source code, then proceed to compile the binary yourself.
- Uploading your compiled binaries to https://virustotal.com and leaving an up-vote or a comment would be helpful as well.
- Uploading your compiled binaries to https://virustotal.com and leaving an up-vote or a comment would be helpful as well.

0 comments on commit 74c84aa

Please sign in to comment.