marvin-zhao / ipaddr-py

Automatically exported from code.google.com/p/ipaddr-py
0 stars 0 forks source link

README insufficiency #110

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
I am fairly new to Python and have never installed a third-party module before 
today.  I downloaded ipaddr-2.1.11.tar.gz from 
https://docs.python.org/2/install/ and noticed that it had a README but no 
“installer” file that I recognized.  The README provided interesting 
background information and helpful contact information, but no instructions.  I 
did a quick Google search and found 
https://docs.python.org/2/install/#the-new-standard-distutils where it says… 

Additionally, the distribution will contain a setup script setup.py, and a file 
named README.txt or possibly just README, which should explain that building 
and installing the module distribution is a simple matter of running one 
command from a terminal:
python setup.py install
For Windows, this command should be run from a command prompt window (Start ‣ 
Accessories):
setup.py install

This was exactly what I needed to know and made the installation a snap.  
However if this simple information had been in the README (as docs.python.org 
recommends) then it would have saved me another step.

If you wanted to add this information you could also remind the Linux users to 
run setup.py with root privileges (adding “sudo” to the command quoted 
above) because some people (like me) frequently forget that step.

Hope this helps,
Scott Hinton

Original issue reported on code.google.com by sehin...@asu.edu on 7 Aug 2014 at 3:39