byterun icon indicating copy to clipboard operation
byterun copied to clipboard

Improve read me

Open clozinski opened this issue 8 years ago • 2 comments

I have improved the README.rst file. I have linked to a number of important references. All the links work. I have added friendly welcoming text. I have added some history. If there is anything else you would like me to do to the README. rst file, please let me know.

And of course thanks to all the people who did the really hard work of writing the software.

clozinski avatar Mar 14 '17 18:03 clozinski

xref #23

llllllllll avatar Mar 14 '17 21:03 llllllllll

Sorry it took a while for me to get to this.

No worries. I understand that this is not your day job. And when you did reply, you did a very thorough job. Most appreciated.

I am also mindful that I have not yet responded to Allison’s excellent comments. Lots to learn before I can reply intelligently.

I would like to start by asking at a high level what you think is missing from the current README.

Great question. Four things are missing. One is context. What are the related issues? Second is motivation. Why does this project exist? Third is an introduction. We should link to Allison’s excellent article. And finally a reading list is needed. What else should a person read if they want to learn more?

Maybe the last is easiest for me to answer. I am busy reading everything I can find, digging down into how cPython works. Maybe I also need to read more about PyPy. And in the process, I am creating a curated list of recommended references. In due course I will share it.

As for motivation, you say that

Byterun aims to be a tool used to debug a subset of CPython execution.

I see it as a way to learn how to implement Python on a stack machine. I wonder how others see it?

So thanks for the excellent feedback. In due course I will update the proposed README.

Warm Regards Christopher Lozinski http://iosLinks.info http://PythonLinks.info

clozinski avatar Mar 20 '17 11:03 clozinski