search

Janzert / AEI

The Arimaa Engine Interface provides a standard method to communicate and control an Arimaa bot.
http://arimaa.janzert.com/aei/
Other
22 stars 5 forks source link

Expanded the readme and moved to MarkDown. #2

Closed leonm closed 10 years ago

Janzert commented 10 years ago

Thanks for the extra documentation. Over the past month I've been working toward moving the scripts into the pyrimaa package and making everything properly installable using the "standard" python tools (i.e. pip). This eventually will include uploading it to the pypi index. Unfortunately for pypi the readme will need to remain rest format. It may also be getting long enough that the actual script usage examples should split out into a separate file. Either way it ends up working out, while I may not merge this directly, I'll be sure to get your updates in.

leonm commented 10 years ago

Sorry, I wasn't aware of the pypi requirement for the readme as my last Python gig was probably 10 years ago. I just jumped in and did what looked pretty on GitHub :-)

Would you like me to change the format?

I also started getting some bits and bobs together to write some docs the the gameroom script. Which I'll pass on to you.

Janzert commented 10 years ago

Don't worry the pypi requirement is very newly on the horizon. If you had pushed this in March I would have directly merged it. It's just in the last couple of months that I started working toward following more of the python norms. Of course the whole purpose of that is to try and end up with a better user experience. Fortunately so far as getting nice github rendering goes it looks like just moving readme.txt to readme.rst will suffice.

I just got back from a 3 week business trip yesterday so it will take me a little bit to get everything sorted so I can get the time to spend on AEI again. Don't worry about reformatting what you've got here, I can do that simply enough when pulling it in. If you get more written in the meantime feel free to pop it into a new issue directly.

Janzert commented 10 years ago

Got a bit of free time today and added this in as usage.rst for the moment. Commit bf15d2beb00f6a4c10e6c60c95e342a8b78df873