[Ns-developers] Python instructions

[Tom Henderson]

>-----Original Message-----
>From: Gustavo Carneiro [mailto:gjcarneiro at gmail.com]
>Sent: Monday, July 14, 2008 06:08 AM
>To: 'ns-developers'
>Subject: [Ns-developers] Python instructions
>
>f I wanted to go ahead and add to ns-3-dev some python instructions (needed
>tools, how to deal with API changes, etc.), in a README file, where would
>you advise me?
>
>   1- In the main README file at the project root
>
>   2- In a README.PYTHON file at the project root
>
>   3- In a bindings/python/README file
>
>Thanks.


I tend to think that README text files in the tree for storing documentation should be used sparingly, since we have several options for storing more structured documentation, such as:

- the texinfo-based manual in doc/manual, available in html at:
http://www.nsnam.org/docs/manual.html, or

- the doxygen \page command can make it land on a Doxygen "Related Pages":
http://www.nsnam.org/doxygen/pages.html
if you want to write it as a doxygen header

I am not going to complain at all, though, if you simply donate documentation in a plain text README-- we can repurpose the information as needed.

Tom