Help with documentation!

M

Thread Starter

Mario de Sousa

Hello all,

When this project started a couple of people came forward offering their help in writing documentation.

Well, the time has come!

If anybody is still willing to help out, could you please come forward once again?

We seem very close to a first release, and it wouldn't make much sense to do it without documentation.

Cheers,

Mario.

--
----------------------------------------------------------------------------
Mario J. R. de Sousa
[email protected]
----------------------------------------------------------------------------

The box said it requires Windows 95 or better, so I installed Linux

_______________________________________________
LinuxPLC mailing list
[email protected]
http://linuxplc.org/mailman/listinfo/linuxplc
 
M

Mario de Sousa

Aditya and Marcelo,

Thanks for coming forward.

My suggestion to you now is that you glance through the little
documentation that we have already and try to figure out how things
work. When you don't understand something, just give me a shout and I'll
do the best I can to explain.
http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/mat/doc/
You might want to start off with the skeletan of the user manual that Jiri has created.
http://mat.sourceforge.net/manual/
What I feel needs to be added are:
- A section on how to confiugre the core of the plc
(The sample linuxplc.conf file should be your friend here)
http://mat.sourceforge.net/manual/appendix/linuxplc.conf
- Sections on how to configure each io module, and what each really
does.
(i.e. the ciodio, parport, cif and modbus)
The sample linuxplc.conf files in each of the demo
directories could probably be used as a starting point.
I would leave the modbus till later, as it will
probably be changed in the near future.
- Section on how to configure the dsp module, and how it works.
Once again, you might want to use the demo config file
as a starting point.
- Section on how to code new plc modules.
This is, in essence, documenting the API to the PLC.

Maybe you can come up with other stuff that should be in the user manual, and a better way to organize it?

Once again, please don't hesitate to ask whenever you feel the need.

Why don't each of you choose a section where you would like to start?

Cheers

Mario.

----------------------------------------------------------------------------
Mario J. R. de Sousa
[email protected]
----------------------------------------------------------------------------

The box said it requires Windows 95 or better, so I installed Linux

_______________________________________________
LinuxPLC mailing list
[email protected]
http://linuxplc.org/mailman/listinfo/linuxplc
 
Top