Re: [ng-spice] Docs
Arno wrote:
> The online documentation should be compiled into the program (as
> opposed to be put in a separate file). This allows for i18n using the
> gettext library. For a more extensive treatment of the subject, we
> could fork an info reader or web browser and have it search for the
> relevant term in the index. This is what Octave (a Matlab
> replacement) does. It works quite nicely.
Agreed. But don't we have the same problem with gettext as with readline? I'm
not sure whether gettext is GPL or not (but read my next post about licensing
issues)
>
> So far, the texinfo manual mostly covers the needs of the seasoned
> users. It mostly lacks a good index to be truly useful. On the other
> hand, I would like to see the descriptions of the devices be put in
> their respective directories. This also fits nicely into the proposed
> library approach to the device simulation. The final reference
> documentation can include the different parts.
I think this is rather heavy - don't forget that many devices have been
very well documented elsewhere (like bsim3 for instance). Should we include
this documentation? I'd rather do the documentation as a reference, but
distribute
it separately (via a web page would be the easiest - we can put links)
We should only supply a users manual in the tar.gz.
> Let it be clear that I am all in favour of junking the old system.
yup.
manu
Partial thread listing: