Skip to content

Commit dd32601

Browse files
authored
update: adding more local build details to the README.md (#1022)
1 parent f25bfd6 commit dd32601

1 file changed

Lines changed: 28 additions & 1 deletion

File tree

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,37 @@ Requirements:
121121
* [rust](https://www.rust-lang.org) - yara-x requirement
122122
* [yara-x](https://virustotal.github.io/yara-x/) - Rust implementation of YARA
123123
* [pkgconf](http://pkgconf.org/) - required by Go to find C dependencies, included in many UNIX distributions
124+
* [libssl-dev](https://packages.debian.org/buster/libssl-dev) package
124125

125126
To install yara-x, first install Rust and then run `make install-yara-x` which will clone the yara-x repository and install yara-x's dependenicies and its C API.
126127

127-
For more information about the yara-x C API, reference the documentation here: https://virustotal.github.io/yara-x/docs/api/c/c-/#building-the-c-library.
128+
### Building locally in Debian/Ubuntu
129+
130+
1. Install the dependencies. On Debian/Ubuntu you can run:
131+
132+
```bash
133+
sudo apt-get install -y pkgconf libssl-dev
134+
```
135+
136+
Make sure [Go](https://go.dev/doc/install) and [Rust](https://www.rust-lang.org/tools/install) are installed
137+
138+
2. Run `make install-yara-x` to build the yara-x C API. (The
139+
`yara_xcapi.pc` file will be generated under `./out/lib/pkgconfig`.
140+
For more information about the yara-x C API, reference the documentation here: https://virustotal.github.io/yara-x/docs/api/c/c-/#building-the-c-library.).
141+
142+
3. Build the malcontent binary with:
143+
144+
```bash
145+
make out/mal
146+
```
147+
148+
The resulting binary is `out/mal`.
149+
150+
4. OPTIONAL: Install the binary
151+
152+
```bash
153+
sudo install out/mal /usr/local/bin
154+
```
128155

129156
## Help Wanted
130157

0 commit comments

Comments
 (0)