Просмотр исходного кода

improve documentation

- tell users they can install from pip.
- windows specific instructions regarding compiling
  pycrypto.
oz123 11 лет назад
Родитель
Сommit
6207edc0e5
1 измененных файлов с 19 добавлено и 9 удалено
  1. 19 9
      README.md

+ 19 - 9
README.md

@@ -14,11 +14,6 @@ Besides managing and storing passwords, Pwman3 can also generate passwords using
 
    If you are a concerned about security, please note:
    PWMAN3 is a very very basic software, which was designed to be used in a safe environment. 
-   - it does not - at the moment - include enchanched security features, due to lack of resourecs. 
-   - I would realy like you to use PWMAN3, so I could get feedback and more ideas, especially, if you
-   know something about security (which is probably more than I know at the moment. 
-   - Be patient, I am working on PWMAN on my free time, and for fun, so don't expect PWMAN3 to 
-     do to more than storing your passwords. 
    - If you are afraid that PWMAN3 is to weak for your needs ... and you still want to try it, here
      are a few recommendations:
      1. Use the AES encryption, it is supposed to be better the Blowfish. 
@@ -26,6 +21,10 @@ Besides managing and storing passwords, Pwman3 can also generate passwords using
         store it completely away from your computer on a separate USB key. 
      3. Use a HARD to crack password to encrypt your database!
    - If you care, report bugs, and send patches. 
+   - I would realy like you to use PWMAN3, so I could get feedback and more ideas, especially, if you
+   know something about security (which is probably more than I know at the moment. 
+   - Be patient, I am working on PWMAN on my free time, and for fun, so don't expect PWMAN3 to 
+     do to more than storing your passwords. 
    
 ## Installing 
 
@@ -46,8 +45,6 @@ for nicer functionality:
     
     xsel - to copy password to clipboard on Linux
     
-
-
 Pwman now uses argparse, which is only
 available in Python 2.7. Therefore, if you intend to use
 pwman3 with an older version of Python, please do so before
@@ -59,12 +56,25 @@ installing:
 Note that the old startup script of pwman3 might have limited
 functionality compared to the newer version. 
 
-To install:
+To install from source:
 
     $ python setup.py install
 
-## User Interface
+You can also install PWMAN3 using python pip:
+
+    $ pip install pwman3
+
+### Windows Users:
 
+You need to compile python-crypto using mingw, after you downloaded the source code of
+pycrypto and extracted it do the following inisde the source code direcotry:
+
+    C:\Temp\pycrypto> python setup.py build -c mingw32 
+    C:\Temp\pycrypto> python setup.py install
+
+Now you should be able to run pwman3 on Windows.
+
+## User Interface
    1. When xsel is install on a Linux system, you can copy passwords directly to clipboard with the copy command.
    2. The command 'open' will open the default browser if URL is specified.
    3. An automatic 'clear screen' function is called after printing an entry in the database.