search

AprilAndFriends / theoraplayer

A multi-threaded C++ library that plays video files supporting multiple codecs across platforms. Easy to use, fast, responsive, abstract interface and minimal dependencies, you'll soon be wondering how you lived without it! ;) Audio and Video interfaces are completely abstracted so the library can be used anywhere, regardless of what you use to display video frames and play audio samples (eg. OpenGL / OpenAL, Direct3D / DirectSound?, SDL / SDL_mixer, X11 / alsa ...) The library can pre-cache video frames and decoded audio samples for maximum efficiency and smooth playback, even on single-cpu systems. Currently, the library supports Theora on Windows, Mac, iOS, Linux, Android, WinRT and Windows Phone. H.264 is supported on Mac and iOS.
BSD 3-Clause "New" or "Revised" License
84 stars 43 forks source link

No README document #10

Open blloyd75 opened 8 years ago

blloyd75 commented 8 years ago

There is no readme document included with this project. The website http://libtheoraplayer.cateia.com/wiki/index.php/Main_Page appears to be very out of date with regard to the project.

blloyd75 commented 8 years ago

I would like to help put together a basic readme document for this project, but would like feedback before I do so.

Since I am actively building on both PC (Visual Studio) and Mac currently, and can test building on Linux easily, I can include basic build instructions for all platforms. I can also include a link to the main wiki site if it will be getting further updates (making it prominent in this case), or treat as a reference link if the site won't be updated more.

Along with basic build instructions, it can list some surprises or features that might not be obvious, such as building DebugS after Debug will possibly overwrite the Debug files.

See Issue 9 for potential issues users not familiar with all design decisions can experience.

kspes commented 8 years ago

Sure, that sounds great. I'm not sure how flexible the readme on github is, I'd prefer it if we just keep a minimal readme on github, just basic info to get started, while all the instructions be written on the wiki.