Add decription what does my_package.media_files = ['sound.mp3', 'images/image.jpg']

kerrickstaley / genanki

A Python 3 library for generating Anki decks

MIT License

1.99k stars 150 forks source link

Add decription what does my_package.media_files = ['sound.mp3', 'images/image.jpg'] #92

Closed dragancevs closed 1 year ago

dragancevs commented 2 years ago

Hello, it would be great to explain in manual what does my_package.media_files = ['sound.mp3', 'images/image.jpg']

SumZbrod commented 2 years ago

Hello, it would be great to explain in manual what does my_package.media_files = ['sound.mp3', 'images/image.jpg']

the package is like a deck, but with media files: my_package = genanki.Package(my_deck) my_package.media_files = audio_list # some list like ['sound.mp3', 'images/image.jpg'] my_package.write_to_file('deck_name.apkg') P.S.: I spent 1 day figuring this out, hopefully it helps someone like me. And I hope it gets inserted into the documentation.

chambln commented 1 year ago

This seems to be documented quite thoroughly in the readme, so I think this can be closed now.

https://github.com/kerrickstaley/genanki/blob/336b666/README.md?plain=1#L80-L104

kerrickstaley commented 1 year ago

Agree with what chambln wrote; I think this is pretty well covered in the README. I intend to get a more detailed docs site up but don't have time right now.