search

shadow / tornettools

A tool to generate realistic private Tor network models, run them in Shadow, and analyze the results.
Other
34 stars 15 forks source link

Add comment to readme about '--editable' pip flag #89

Closed stevenengler closed 2 years ago

stevenengler commented 2 years ago

The --editable flag is probably always what people who want to make changes to tornettools want to use, and I always need to look up what the flag is each time I install tornettools, so it's probably helpful to add this to the readme. I also expanded the -I flag to --ignore-installed since it's a non-obvious flag, and I also have to always look that one up to see what it's doing.

stevenengler commented 2 years ago

Do we want a concise note about why --editable is actually needed? I don't think I've ever used that flag before.

It's not needed, it just makes it a lot less painful to work on tornettools (you don't need to re-run pip install every time you make a change). I don't know how to explain it concisely, so I just added a link to the documentation.