From 902354993f728cbf63443a018194ab2f8bab7293 Mon Sep 17 00:00:00 2001 From: Jake Mercer Date: Fri, 27 Sep 2019 20:25:20 +0100 Subject: [PATCH 1/2] README/Dependencies - Updated "Quickstart Guide" Updated the Quickstart Guide section of the README as some deviations were required when following this with a fresh Ubuntu 16.04 install. Fixes to ''requirements.txt'' were required to remove the "futures" dependency which is in the python3 standard library and is only intended for use with python2; "fasm" now goes by "pyfasm". Signed-off-by: Jake Mercer --- README.md | 20 +++++++++++++------- requirements.txt | 3 +-- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 68d1f6b0..725c1130 100644 --- a/README.md +++ b/README.md @@ -46,26 +46,32 @@ Build the C++ tools: make build ### Step 5: ### +Alias python to python3 to avoid using python2 accidentally: + + alias python=python3 + +Choose one of the following options: + (Option 1) - Install the Python environment locally - sudo apt-get install virtualenv python3-virtualenv python3-yaml + sudo apt-get install virtualenv python3 python3-pip python3-virtualenv python3-yaml make env (Option 2) - Install the Python environment globally - sudo apt-get install python3-yaml - sudo pip3 install -r requirements.txt + sudo apt-get install python3 python3-pip python3-yaml + sudo -H pip3 install -r requirements.txt This step is known to fail with a compiler error while building the `pyjson5` -library when using Arch Linux and Fedora. `pyjson5` needs one change to build -correctly: +library when using Arch Linux and Fedora. If this occurs, `pyjson5` needs one +change to build correctly: git clone https://github.com/Kijewski/pyjson5.git cd pyjson5 sed -i 's/char \*PyUnicode/const char \*PyUnicode/' src/_imports.pyx sudo make -This might give you and error about `sphinx_autodoc_typehints` but it should +This might give you an error about `sphinx_autodoc_typehints` but it should correctly build and install pyjson5. After this, run either option 1 or 2 again. ### Step 6: ### @@ -88,7 +94,7 @@ Python API with a pre-generated database) ### Step 8: ### Pick a fuzzer (or write your own) and run: - cd fuzzers/010-lutinit + cd fuzzers/010-clb-lutinit make -j$(nproc) run ### Step 9: ### diff --git a/requirements.txt b/requirements.txt index 9554a1e2..b0ea82b4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,4 @@ -fasm -futures +pyfasm intervaltree junit-xml numpy From ceddeaa48b94db890f8320f82d870b05417edcc7 Mon Sep 17 00:00:00 2001 From: Jake Mercer Date: Fri, 27 Sep 2019 22:00:15 +0100 Subject: [PATCH 2/2] README/Dependencies - Fixes Following Review Changing "fasm" to "pyfasm" was incorrect; it is unrelated to this project. Updated this line in ''requirements.txt'' to install "fasm" from the submodule ''third_party/fasm''. Also, removed aliasing of "python" in README. Signed-off-by: Jake Mercer --- README.md | 4 ---- requirements.txt | 2 +- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 725c1130..6beb0541 100644 --- a/README.md +++ b/README.md @@ -46,10 +46,6 @@ Build the C++ tools: make build ### Step 5: ### -Alias python to python3 to avoid using python2 accidentally: - - alias python=python3 - Choose one of the following options: (Option 1) - Install the Python environment locally diff --git a/requirements.txt b/requirements.txt index b0ea82b4..4a9f9c7f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -pyfasm +-e third_party/fasm intervaltree junit-xml numpy