Add python3 dependency

B2R2-org · Aug 22, 2023 · 251720d · 251720d
1 parent 77eb5d5
commit 251720d
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -40,17 +40,32 @@ FunProbe         (the root directory)
  +-...
 ```
 
+### Setting up Python3
 
-## Building FunProbe
+`FunProbe` does not need any special Python3 packages. However, for
+experimental scripts, `pyelftools` is required. To install pyelftools,
 
-Clone the repository:
 ```
-user@ubuntu:~$ git clone https://github.com/B2R2-org/FunProbe.git
+user@ubuntu:~/FunProbe$ python3 -m pip install pyelftools
+```
+
+or
+
+```
+user@ubuntu:~/FunProbe$ python3 -m pip install -r requirements.txt
 ```
 In this document (and other documents in this repository), we assume that you
 cloned the repository at `~/FunProbe`. The prefix before commands will indicate
 where you need to execute the command.
 
+
+## Building FunProbe
+
+Clone the repository:
+```
+user@ubuntu:~$ git clone https://github.com/B2R2-org/FunProbe.git
+```
+
 To build FunProbe, type the following command:
 ```
 user@ubuntu:~/FunProbe$ dotnet build -c Release

diff --git a/REQUIREMENTS.md b/REQUIREMENTS.md
@@ -22,7 +22,7 @@ installing `FunProbe` on the naive system requires the
 following software dependencies:
 
 - .NET 6.0
-- Python3
+- Python3 (with `pyelftools` package)
 - GNU Binutils
 
 To build Docker environments, one additionally needs

diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+pyelftools