Documentation - Githubissues

crowdAI / marLo

Multi Agent Reinforcement Learning using MalmÖ

MIT License

244 stars 46 forks source link

Documentation #38

Closed idvhfd closed 6 years ago

idvhfd commented 6 years ago

Added documentation draft including env descriptions and gifs #32

spMohanty commented 6 years ago

@idvhfd : Merged. Thanks. Can you also update the GIFs on the main readme page ?

spMohanty commented 6 years ago

@idvhfd : Its weird. But I myself added the gifs to the readme, but they are not rendered by github -_- !! Can you also have a look and see why that might be happenning ?

spMohanty commented 6 years ago

@idvhfd : Okay figured it out. Github caches all media content using camo, and it breaks when the file size is large. Its because the gif sizes are too large. It can be solved by,

downloading all the gifs
compressing them using something like : https://ezgif.com/optimize
Ensuring that the gif < 5MB is size
reuploading and relinking the gifs in the documentation.

idvhfd commented 6 years ago

All gifs compressed and committed for both available_envs.rst and README.rst.

I referenced #32 in commits, but please take a look and see if this works.

It was a pain in the backside

^ getting that piece of text above right took a lot of edits, yes.