Closed sy2002 closed 3 years ago
Convert (and maybe reformat) all .txt documentation in /doc into .md due to nicer readability within GitHub EDIT: Not this time (not in V1.6).
Sift through all documentation parts (such as doc/README.md and others) and fix old MMIO addresses
Check and possibly fix the inital walkthrough
Add more TODOs from VERSIONS.txt here
@bernd-ulmann Currently, only the programming card explains the flag behaviour of CMP. The intro document does not.
I removed the SHL/SHR footnotes from both documents and added slide describing the behaviour of the CMP-instruction in the introductory slide set. :-)
@bernd-ulmann Sometimes I can be a nitpicker, I know, but I cannot stop it :-) Please look at this image, it shows the PDF version of the newly updated QNICE intro pdf:
as part of this issue: update doc/how-to-release.md and VERSIONS.txt
WOW! Eagle eyed! :-) It's fixed now. :-)
as part of this issue: update doc/how-to-release.md and VERSIONS.txt
...I don't have these two files in doc/?!
if VASM is not updated in V1.6 (see issue #65) then we need to document this fact in constraints.txt
...I don't have these two files in doc/?!
@bernd-ulmann Sorry, I did not commit yet doc/how-to-release.md. Done now. VERSIONS.txt is sitting in the main folder.
In the QNICE main folder, there sits VERSIONS.txt. I rececntly updated it to reflect everything we did in V1.6 and boy is this a looooong list :-) I am pretty happy with the sheer volume of V1.6 ;-)
@bernd-ulmann Please look at all the @bernd tags in VERSIONS.txt and check, if I got everything related to your work in V1.6 right. Feel free to add/edit at will and then remove all @bernd tags.
@MJoergen Please look at the @michael tags in VERSION.txt and check, if I got everything related to your work in V1.6 right. Feel free to add/edit at will and then remove all @michael tags.
I've checked my part in VERSIONS.txt and updated it.
I updated quite a lot of documentation. Here are the remaining TODOs for this issue:
dist_kit
: Fix the references in hw/README.md
and README.md
doc/how-to-release.md
@MJoergen Can you have a look at the first two checkboxes in the list above? I would then take the others.
README.md
refers to dist_kit/qnice-v141.bit
in several places. I guess we really need two different bit-files: One for Nexys4DDR and one for MEGA65. @sy2002 dist_kit/q-tris.bit
in several places. The same comment applies here. @sy2002 ADD/SUB 0x0100, R14
replaced with INCRB/DECRB
. @bernd-ulmann The programming card has been updated. :-)
@MJoergen Can you have a look at the first two checkboxes in the list above? I would then take the others.
Done.
Note to self I need to update the compiler documentation in doc/vbcc.txt, doc/constaints.txt and doc/best-practices.md to cover the ISR handling and -speed
__interrupt __rbank void irq(void)
{
...
}
ISR and other VBCC documentation updated in commit 56d0596
MEGA65/README.md
("WIP HyperRAM Driver") also needs to be updated
Update the qnice-fpga.com website: new version number, mention hardware platforms, mention Vivado, add Michael to the contributors
Everything done. V1.6 is released.
Impressive! Turns out V1.6 is a really big release. Congrats to all of us!
Update all documentation for 1.6