6 ms·
Wow Turing Scholars! you guys are like the navy seals of CS at UT lol. Yes I appreciate the insight and will actually hand write it (and copy some parts of this
by mrr7337 2mo ago
Wow Turing Scholars! you guys are like the navy seals of CS at UT lol. Yes I appreciate the insight and will actually hand write it (and copy some parts of this post, but it is a bit too goofy to just use the post straight up). One thing you mentioned, I've never heard of Readmes including a history of the project, because I thought Readmes were like a small intro doc with a bunch of hyper links only.
For example, I looked at the these two Readmes:
https://github.com/rybbit-io/rybbit/blob/master/README.md https://github.com/rybbit-io/rybbit/blob/master/README.md <-- this one is lovely
https://github.com/supabase/supabase/blob/master/README.md https://github.com/supabase/supabase/blob/master/README.md
Both include pictures, features, ect, but not really histories, unless I'm understanding your comment incorrectly.
- Doches 2mo agoDid you look at them, or did you just tell Claude to look at them? /s Seriously, though — if the history is valuable and interesting, include it. If it provides context in general, include it; if it’s just overconfident marketing fluff straight from the parrot’s mouth, drop it. I like my READMEs to open with the ‘why’ of the project: why I built it and why you might need it too.
- mrr7337 2mo agoLol. Yeah, do you have a good example I can follow and learn from? That would probably help explain well.