Skip to content

Commit f4b203c

Browse files
committed
doc:add run instructions to help user with cli interface
1 parent afd78c2 commit f4b203c

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

+47
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,53 @@ As malware advances, new bypass techniques are been developed in a typical Cat a
1212

1313
For this a recurrently refreshed Dataset is needed. Most Research on this topic provides a "One point on time view" where the researcher collects samples, train the model and publish results at this point on time. But later models are not been evaluated, or retrained based on a recurrently collected model.
1414

15+
# Installation
16+
17+
1. **Clone the repository:**
18+
19+
```bash
20+
git clone https://github.com/Anti-Malware-Alliance/your-daily-dose-malware.git
21+
```
22+
23+
2. **Go to the project directory:**
24+
```bash
25+
cd your-daily-dose-malware/
26+
```
27+
28+
3. **Create a virtual environment:**
29+
```bash
30+
python3 -m venv daily-dose
31+
or
32+
python -m venv daily-dose
33+
```
34+
35+
4. **Activate the virtual environment:**
36+
```bash
37+
poetry shell
38+
```
39+
40+
5. **Install dependencies:**
41+
```bash
42+
poetry install
43+
```
44+
45+
# Using CLI Interface
46+
If you want to download fresh malware samples uploaded since 48 hours
47+
```bash
48+
cd your-daily-dose-malware/
49+
python main.py -s256
50+
51+
```
52+
this could be an amount of 300 samples or more.
53+
54+
But if you're not that hungry, maybe 100 samples will satisfy your hunger.
55+
56+
```bash
57+
cd your-daily-dose-malware/
58+
python main.py -hr
59+
```
60+
this will always download 100 samples. uploaded since 1 hour.
61+
1562
# Solution
1663

1764
Currently looking for a Collaborator for initial write up.

0 commit comments

Comments
 (0)