Hi all,
I start this thread for discussing documentation.

At this stage, I think that we have made enough architecture decisions to give us good idea on how to start implementing the encoder. I think we should keep a design document up-to-date with architecture decisions and with implementation. this way, all developers will have a clear idea on implementation, and developers that will join in the middle of the project will have easy access. I can see many more advantages for good up-to-date documentation, but these two reasons should do.

I suggest we use the template on this web-site (http://www.opencores.com/downloads/specification_template.dot) to start with. I wouldn't mind assembling all decisions made so far and write these into the template, unless someone else would like to take this task. After we get a preliminary draft agreed and understood by all, we could start coding.

Afterwards, any implementation decision done by different teams/developers could be updated in the design document by the developers.

I suggest using .doc document format, which is compatible with open-office(linux) and word (windows). I know that TortoiseSVN has special built-in word-format diff feature. I'm not familiar with such feature for any linux svn client (anyone?), but open-office has a "compare documents" feature that can do the work.

please write your opinion.
- gil

Gil,

I am not able to access the link. Is it a valid one?

-Gijo

If you click on the link, the address contains ")" in the end that is invalid. remove ), it will work.