An effort to update Readme

networkx / networkx-metis

NetworkX Addon to allow graph partitioning with METIS

Other

79 stars 21 forks source link

An effort to update Readme #31

Closed OrkoHunter closed 9 years ago

OrkoHunter commented 9 years ago

Here is an attempt to write the Readme with About, Installation, Documentation and Contribution sections. Comments are most welcome.

The repository with updated readme will look similar to the readme branch on my fork.

landscape-bot commented 9 years ago

Code quality remained the same when pulling 76e8301 on OrkoHunter:readme into 54ebd96 on networkx:master.

OrkoHunter commented 9 years ago

Good work landscape-bot !

landscape-bot commented 9 years ago

Repository health decreased by 2% when pulling b7c32e2 on OrkoHunter:readme into 872cda0 on networkx:master.

1 new problem was found (including 1 error and 0 code smells).
No problems were fixed.

chebee7i commented 9 years ago

It is up to you if you want to have landscape comment. I think it tends to make the PRs noisy.

OrkoHunter commented 9 years ago

Yes. Let's disable the comments. I'll check for the errors, smells from the site itself.

MridulS commented 9 years ago

@chebee7i On a side note: Can we have landscape for networkx also?

OrkoHunter commented 9 years ago

There's an issue open about it https://github.com/networkx/networkx/issues/1492

OrkoHunter commented 9 years ago

Addressed all comments.

MridulS commented 9 years ago

On a side note: Should we advise users to use virtualenv? I don't think running pip install networkx will work. It has to be sudo pip install networkx or to avoid touching OS files pip install --user networkx, right?

OrkoHunter commented 9 years ago

This is the general way to show the installation procedure. You do not add sudo anywhere, nor you are advised to touch the system files.

MridulS commented 9 years ago

Should we add a note or leave it to the user to figure it out? (This can happen with someone who is new to python)

ysitu commented 9 years ago

@MridulS I think that knowledge about pip is not something for us to worry about. A user who is to use pip install should know what it does. networkx-metis will not be the only package he/she runs into problems with.

OrkoHunter commented 9 years ago

I've added few lines in the Windows section for installation. Also, I've added an example, though I'm sure we can have (a) better example(s). Can anyone suggest a good graph to partition to put as an example?