search

bontchev / pcodedmp

A VBA p-code disassembler
GNU General Public License v3.0
450 stars 85 forks source link

Website installation instructions are incomplete #5

Closed GadgetSteve closed 5 years ago

GadgetSteve commented 5 years ago

The Installation section of the current web site mentions installing the pre-requisite oletools but does not mention actually installing pcodedmp this could lead to inexperienced or even experienced but time challenged users failing to install it.

Please consider adding pcodedmp to the two pip lines given or having a separate line of: pip install -U pcodedmp

bontchev commented 5 years ago

I'm not sure I understand the problem... If you install pcodedmp with pip, it will install the right version of oletools. The instructions in the "Installation" section are for manually downloading the script from GitHub and using it; they were written before pcodedmp was installable with pip.

GadgetSteve commented 5 years ago

The problem is that if the users follow the installation section instructions literally they will install oletools instead of pcodedmp not with it.

From: Vesselin Bontchev notifications@github.com Sent: 22 March 2019 10:11 To: bontchev/pcodedmp pcodedmp@noreply.github.com Cc: Steve (Gadget) Barnes gadgetsteve@hotmail.com; Author author@noreply.github.com Subject: Re: [bontchev/pcodedmp] Website installation instructions are incomplete (#5)

I'm not sure I understand the problem... If you install pcodedmp with pip, it will install the right version of oletools. The instructions in the "Installation" section are for manually downloading the script from GitHub and using it; they were written before pcodedmp was installable with pip.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/bontchev/pcodedmp/issues/5#issuecomment-475563459, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AFVaWlrYCajmk-nKe2oOHWuetKS7uvBoks5vZKxBgaJpZM4cDJpC.

bontchev commented 5 years ago

But if they install oletools (as described in the Installation section), they don't need to install pcodedmp - it can simply be downloaded from the repository and will run anywhere. I ended up making pcodedmp installable via pip mostly to save the user the trouble to install any dependencies first (of which there currently is only one - oletools - but this could change in the future and I was trying to make things simpler for the user...

Do you want me to just add at the end of the Installation section something like

Alternatively, you can install pcodedmp directly with pip by using the command pip install -U pcodedmp and it will take care of installing all the necessary dependencies (like oletools).

GadgetSteve commented 5 years ago

Sounds good. My concern was that someone, (like myself), could follow the install instructions: pip install oletools and then type pcodedmp and receive an error message as despite following all of the current instructions in the installation section I have not yet installed pcodedmp. This actually happened to me.

From: Vesselin Bontchev notifications@github.com Sent: 22 March 2019 14:53 To: bontchev/pcodedmp pcodedmp@noreply.github.com Cc: Steve (Gadget) Barnes gadgetsteve@hotmail.com; Author author@noreply.github.com Subject: Re: [bontchev/pcodedmp] Website installation instructions are incomplete (#5)

But if they install oletools (as described in the Installation section), they don't need to install pcodedmp - it can simply be downloaded from the repository and will run anywhere. I ended up making pcodedmp installable via pip mostly to save the user the trouble to install any dependencies first (of which there currently is only one - oletools - but this could change in the future and I was trying to make things simpler for the user...

Do you want me to just add at the end of the Installation section something like

Alternatively, you can install pcodedmp directly with pip by using the command pip install -U pcodedmp and it will take care of installing all the necessary dependencies (like oletools).

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/bontchev/pcodedmp/issues/5#issuecomment-475651531, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AFVaWp1nIcAmMKoN9You-N2wg2GYwBeCks5vZO5fgaJpZM4cDJpC.

bontchev commented 5 years ago

OK, done. Closing the issue now.