From gitlab at videolan.org Tue Jun 15 13:07:04 2021 From: gitlab at videolan.org (Jean-Baptiste Kempf) Date: Tue, 15 Jun 2021 15:07:04 +0200 Subject: [libdvdnav-devel] [Git][videolan/libdvdread][master] Move README to README.md Message-ID: <60c8a5f8ceba9_93731abeac5c12231510@gitlab.mail> Jean-Baptiste Kempf pushed to branch master at VideoLAN / libdvdread Commits: cddaf6e4 by Mathias Couder at 2021-06-15T13:07:01+00:00 Move README to README.md And notably add VideoLAN Code of Conduct and improve lisibility - - - - - 3 changed files: - Makefile.am - − README - + README.md Changes: ===================================== Makefile.am ===================================== @@ -2,7 +2,7 @@ ACLOCAL_AMFLAGS = -Im4 AM_CPPFLAGS = -I$(top_srcdir)/src -I$(top_builddir)/src/dvdread $(CSS_CFLAGS) -dist_doc_DATA = AUTHORS ChangeLog COPYING NEWS README TODO +dist_doc_DATA = AUTHORS ChangeLog COPYING NEWS README.md TODO MAINTAINERCLEANFILES = ChangeLog ===================================== README deleted ===================================== @@ -1,57 +0,0 @@ -What is this all about? ------------------------ - -libdvdnav is a library that allows easy use of sophisticated DVD navigation -features such as DVD menus, multiangle playback and even interactive DVD games. -All this functionality is provided through a simple API which provides the -DVD playback as a single logical stream of blocks, intermitted by special -dvdnav events to report certain conditions. The main usage of libdvdnav is a -loop regularly calling a function to get the next block, surrounded by -additional calls to tell the library of user interaction. -The whole DVD virtual machine and internal playback states are completely -encapsulated. - -Where does it come from? ------------------------- - -This library is based on a lot of code and expertise from the Ogle project. -Ogle was the first DVD player who implemented free DVD navigation. The -libdvdnav developers wish to express their gratitude to the Ogle people -for all the valuable research work they have done. - -Initially, the dvdnav code was part of a plugin to the xine media player -called xine-dvdnav. Later on, the DVD VM specific code was split -from xine-dvdnav and went into the first version of libdvdnav. - -Where is it now? ----------------- - -libdvdnav is hosted on http://dvdnav.mplayerhq.hu/ . -Please report bugs to the developers mailinglist at -mailto:dvdnav-discuss at mplayerhq.hu . - -We are still in beta stage, but libdvdnav is already quite usable. With -regular DVD playback, there should not be any serious issues. The library -also makes some limited effort to handle error situations gracefully, but -there are still assertions in the code that may trigger on some DVDs. Please -send a report to the developer mailinglist, if you encounter such problems. - -How can I use it? ------------------ - -libdvdnav is completely licensed under GPL. You may use it at wish within the -bounds of this license. See the file "COPYING" for a copy of the GPL. - -Sources for documentation on libdvdnav are: -* the examples directory contains a simple program using libdvdnav - this one is well-commented and therefore a good starting point -* the public header dvdnav.h documents the API -* the public header dvdnav_events.h documents the dvdnav events -* doc/library_layout contains some info on the internal working of libdvdnav - -Sources for documentation on DVD terminology, structure and surrounding concepts: -* doc/dvd_structures briefly explains DVD terms and organization -* a more detailed description of DVD structures is available at - http://www.mpucoder.com/dvd/ -* the ifo_types.h and nav_types.h headers are also interesting if you - are already used to the sometimes cryptical abbreviations ===================================== README.md ===================================== @@ -0,0 +1,41 @@ +# Goals and features + +**libdvdread** is a library for simpler navigation (DVDs without menus) + +## Where does it come from? + +This library is based on a lot of code and expertise from the **Ogle project**. +**Ogle** was the first DVD player who implemented **free DVD navigation**. The +**libdvdread** developers wish to express their gratitude to the Ogle people +for all the valuable research work they have done. + +Initially, the dvdnav code was part of a plugin to the xine media player +called xine-dvdnav. Later on, the DVD VM specific code was split +from xine-dvdnav and went into the first version of libdvdnav. + +Then, it was forked, and forked again on MPlayer repositories. +libdvdnav and libdvdread were merged, and then split again. + +## Where is it now? + +Libdvdread is hosted [here](http://dvdnav.mplayerhq.hu/). + +You can find more information [here](https://www.videolan.org/developers/libdvdnav.html) + +Please report bugs to the developers mailinglist at +mailto:dvdnav-discuss at mplayerhq.hu . + +## License + +**Libdvdread** is completely licensed under GPL. You may use it at wish within the +bounds of this license. See the file [COPYING](https://code.videolan.org/videolan/libdvdread/-/blob/master/COPYING) for a copy of the GPL. + +## Using libdvdread + +A detailed description of DVD structures is available [here](http://www.mpucoder.com/dvd/) + +All documentation is also accessible [here](http://dvdnav.mplayerhq.hu/#docs) + +## CoC + +The [VideoLAN Code of Conduct](https://wiki.videolan.org/Code_of_Conduct/) applies to this project. View it on GitLab: https://code.videolan.org/videolan/libdvdread/-/commit/cddaf6e478cbaaa634e48d44887fa1bc51e3a02f -- View it on GitLab: https://code.videolan.org/videolan/libdvdread/-/commit/cddaf6e478cbaaa634e48d44887fa1bc51e3a02f You're receiving this email because of your account on code.videolan.org.