VLSI-EDA / PoC

IP Core Library - Published and maintained by the Chair for VLSI Design, Diagnostics and Architecture, Faculty of Computer Science, Technische Universität Dresden, Germany
https://tu-dresden.de/ing/informatik/ti/vlsi
Other
538 stars 93 forks source link

Multiple Examples in the Documentation are the same #28

Closed befedo closed 7 years ago

befedo commented 7 years ago

Hello Guys ...

I don't know if this is a real issue. But while i'm reading the documentation i noticed that there where multiple examples the same.

More precisely the file 'PoC/docs/UsingPoC/Synthesis.rst' contains multiple occurrences of '.\poc.ps1 quartus PoC.arith.prng --board=DE4' from the quartus example.

Thank you for your time and best regards

mzabeltud commented 7 years ago

Yes, you are right. This is a copy & paste error. Will be fixed soon.

Paebbels commented 7 years ago

Hello Marc,

the latest documentation is now fixed. It also contains better document and section linking. The command line switch names are now clickable and direct you to the detailed command line documentation. I also updated the documentation of pre-compile scripts. The updates for the simulation page will be online in a few days.

Thank you for reading our documentation and reporting this issue :)

Kind regards Patrick

befedo commented 7 years ago

Thanks Patrick for the quick fix and the corespondending time and work. This is still an amazing project, from now on with an quite better documentation ... ;)

Thanks for your time and best regards,

Marc

Gesendet: Montag, 21. November 2016 um 17:31 Uhr Von: "Patrick Lehmann" notifications@github.com An: VLSI-EDA/PoC PoC@noreply.github.com Cc: "Marc Ludwig" ludwig.marc@gmx.net, Author author@noreply.github.com Betreff: Re: [VLSI-EDA/PoC] Multiple Examples in the Documentation are the same (#28)

Hello Marc,

the latest documentation is now fixed. It also contains better document and section linking. The command line switch names are now clickable and direct you to the detailed command line documentation. I also updated the documentation of pre-compile scripts. The updates for the simulation page will be online in a few days.

Thank you for reading our documentation and reporting this issue :)

Kind regards Patrick

You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub: https://github.com/VLSI-EDA/PoC/issues/28#issuecomment-261989645

Paebbels commented 7 years ago

May I ask: Are you using PoC in a design or are you just experimenting with our IP cores / tool chain?

I'm also working on a better VHDL reader for a better documentation extraction from VHDL source files. Another new documentation feature is the wavedrom support: See PoC.io.ddrio.in which has now a waveform rendered in HTML+JS+SVG :)

befedo commented 7 years ago

I've chosen PoC as an example for documenting and validating my VHDL resources. And of course there where nice implementations in this library I've just started to digging deeper ...

Furthermore I planed to use techniques like OSVVM/VUnit for testing purposes, but there's still a lot for me to learn about. If you got some tutorials as a starting point, it would be nice if you could share them.

Sorry for my bad english, this is not my native language.

Best Regards,

Marc

Gesendet: Montag, 21. November 2016 um 21:52 Uhr Von: "Patrick Lehmann" notifications@github.com An: VLSI-EDA/PoC PoC@noreply.github.com Cc: "Marc Ludwig" ludwig.marc@gmx.net, Author author@noreply.github.com Betreff: Re: [VLSI-EDA/PoC] Multiple Examples in the Documentation are the same (#28)

May I ask: Are you using PoC in a design or are you just experimenting with our IP cores / tool chain?

I'm also working on a better VHDL reader for a better documentation extraction from VHDL source files. Another new documentation feature is the wavedrom support: See PoC.io.ddrio.in which has now a waveform rendered in HTML+JS+SVG :)

You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub: https://github.com/VLSI-EDA/PoC/issues/28#issuecomment-262063630