amx_assembly icon indicating copy to clipboard operation
amx_assembly copied to clipboard
verified publisher icon Zeex

Write a README

Open Zeex opened this issue 11 years ago • 6 comments

^

Zeex avatar Mar 30 '15 07:03 Zeex

Technically one now exists...

Y-Less avatar Jan 07 '18 09:01 Y-Less

OK then

Zeex avatar Jan 07 '18 14:01 Zeex

I wouldn't say it was a good one though. I didn't actually expect it to be closed given the current state of the readme.

Y-Less avatar Jan 07 '18 14:01 Y-Less

Sorry. I was about to say that it sucks but then I remembered that a readme is better than no readme at all...

I think when I created this issue I meant to make a readme with a high-level overview of all all modules or some kind of documentation. But it could be put in a wiki as well.

Zeex avatar Jan 07 '18 14:01 Zeex

@Y-Less I added an "Overview" section to the README. It's not complete though, I skipped some newer includes because I'm not sure what they do (like addressof). Can you please add a description for them?

Zeex avatar Jan 08 '18 10:01 Zeex

Sure

Y-Less avatar Jan 08 '18 11:01 Y-Less

Well it only took me five years to get around to that! Done...

Y-Less avatar Nov 06 '23 11:11 Y-Less