yupferris / kaze

An HDL embedded in Rust.
Apache License 2.0
194 stars 9 forks source link

Consider writing book/tutorial #14

Open yupferris opened 4 years ago

yupferris commented 4 years ago

This is significant effort for arguably not much payoff at this point, but I'd still like to track it and have this ticket as a place where I can dump ideas etc.

turbinenreiter commented 3 years ago

I'd buy you at least a cup of coffee for a tutorial!

jdonszelmann commented 3 years ago

Working on this. Using MDBook + github pages (through Github CI). Going to frame it as a book in which the goal is to build a simple CPU using Kaze. While achieving that goal, many examples are included as reference, concepts are explained and in general a good introduction to the library is given. How does that sound?

yupferris commented 3 years ago

That sounds good, but I'd appreciate it if you waited until #23 is addressed. I've been putzing on it for a couple months on this branch along with a matching branch in my xenowing project. Granted, I'm not 100% sure I'm convinced of the design changes, but I think they're generally in the right direction.

In fact, you seem quite eager to help with the project, which is appreciated - what I would like most, if you have the time/will, is critical feedback on #23, esp. with motivating examples, if that's possible :)

yupferris commented 3 years ago

Also, bear in mind that my response capacity is somewhat limited these days; I've recently had a child and changed jobs, and the dust is still settling.

jdonszelmann commented 3 years ago

Hey, that's alright. I found the project and thing it's quite cool. I can handle slow responses. I'll look at #23 :)

yupferris commented 3 years ago

cheers, let me know if something is strange/unclear!