[Ns-developers] Python instructions

[Gustavo Carneiro]

2008/7/15 Tom Henderson <tomh at tomh.org>:

>
> >-----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.


Personally I don't feel very comfortable with doxygen or texinfo, so I ended
up writing a wiki page instead:

http://www.nsnam.org/wiki/index.php/NS-3_Python_Bindings

Although it would be nice to at least reference that wiki page in a README
file.

-- 
Gustavo J. A. M. Carneiro
INESC Porto, Telecommunications and Multimedia Unit
"The universe is always one step beyond logic." -- Frank Herbert