From 203b615764bf2c41326d41e5ca04fdff28ea9b17 Mon Sep 17 00:00:00 2001 From: Renato Alves Date: Wed, 21 Nov 2018 14:35:50 +0100 Subject: [PATCH] DOC+MIN Minor syntax changes closes #43 --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0ca9381..e3a7be9 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,13 @@ requested but can be left blank. This tool does not try to crack or brute-force the Master Password in any way. If the Master Password is not known it will simply fail to recover any data. -This script is written in Python and is compatible with versions 2.7+ and 3.4+. On Windows only Python 3 is supported. +This script is written in Python and is compatible with versions 2.7+ and 3.4+. On Windows, only Python 3 is supported. -Additionally it requires access to libnss3 which is part of Firefox and +Additionally, it requires access to libnss3 which is part of Firefox and Thunderbird, although depending on system configuration, the script may fail to locate it there. -Alternatively you can install libnss3 (Debian/Ubuntu) or nss (Arch/Gentoo/...). +Alternatively, you can install libnss3 (Debian/Ubuntu) or nss (Arch/Gentoo/...). libnss3 is part of https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS @@ -46,7 +46,7 @@ script with: python firefox_decrypt.py /folder/containing/profiles.ini/ ``` -If you don't want to display all passwords on screen you can use: +If you don't want to display all passwords on the screen you can use: ``` python firefox_decrypt.py | grep -C2 keyword @@ -128,7 +128,7 @@ python firefox_decrypt.py -vvv ``` If the output doesn't help you identify the cause and a solution to the problem please file a bug report including the verbose output. -**NOTE**: Be aware that your profile password as well as other passwords may be visible in the output so make sure you remove any sensitive data before including it in the bug report. +**NOTE**: Be aware that your profile password, as well as other passwords, may be visible in the output so make sure you remove any sensitive data before including it in the bug report. ##### Windows @@ -137,17 +137,17 @@ If you mix architectures the code will fail. More information on issue [#8](http ##### Darwin/MacOS -If you get the error described in [#14](https://github.com/unode/firefox_decrypt/issues/14) when loading `libnss3` consider installing `nss` using brew or other package manager. +If you get the error described in [#14](https://github.com/unode/firefox_decrypt/issues/14) when loading `libnss3` consider installing `nss` using brew or other package managers. #### Testing -If you wish to run the testsuite locally chdir into `tests/` and run `./run_all` +If you wish to run the test suite locally chdir into `tests/` and run `./run_all` If any test fails on your system please ensure `libnss` is installed. If afterwards tests still fail, re-run with `./run_all -v` and file a bug report including this output. Please include some information about your -system, including linux distribution, and version of libnss/firefox. +system, including Linux distribution, and version of libnss/firefox. It is much appreciated.