[libdvdnav-devel] [Git][videolan/libdvdnav][master] 2 commits: README to README.md

[Jean-Baptiste Kempf (@jbk)]

Jean-Baptiste Kempf pushed to branch master at VideoLAN / libdvdnav


Commits:
c6e20844 by Mathias Couder at 2022-05-24T13:46:45+02:00
README to README.md
- - - - -
08062820 by Mathias Couder at 2022-05-24T13:46:45+02:00
Add documentation links
- - - - -


2 changed files:

- Makefile.am
- README → README.md


Changes:

=====================================
Makefile.am
=====================================
@@ -5,7 +5,7 @@ AM_CPPFLAGS = -I$(top_srcdir)/src \
               $(THREAD_CFLAGS) \
               $(DVDREAD_CFLAGS)
 
-dist_doc_DATA = AUTHORS ChangeLog COPYING README TODO
+dist_doc_DATA = AUTHORS ChangeLog COPYING README.md TODO
 
 EXTRA_DIST = msvc/ \
 	     doc/doxy.conf \


=====================================
README → README.md
=====================================
@@ -1,27 +1,25 @@
-What is this all about?
------------------------
+## Libdvdnav
 
-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
+**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
+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.
+The whole DVD virtual machine and internal playback states are **completely
+encapsulated**.
 
-Where does it come from?
-------------------------
+## Where does it come from?
 
-This library was based on a lot of code and expertise from the Ogle project.
-Ogle was the first DVD player who implemented free DVD navigation. The
+This library was 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.
+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.
+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.
@@ -35,11 +33,12 @@ numerous crashes and maintain a correct player-agnostic library for DVD playback
 This fork will try to maintain correct authorship tracking, by using git and a
 proper history.
 
-How can I use it?
------------------
+## Liscence
 
-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.
+Libdvdnav is completely licensed under GPL. You may use it at wish within the
+bounds of this license. See the [here](https://code.videolan.org/videolan/libdvdnav/-/blob/master/COPYING) for a copy of the GPL.
+
+## Documentation
 
 Sources for documentation on libdvdnav are:
 * the examples directory contains a simple program using libdvdnav
@@ -50,7 +49,14 @@ Sources for documentation on libdvdnav are:
 
 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/
+* a more detailed description of DVD structures is available [here](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
+
+## CoC
+
+The [VideoLAN Code of Conduct](https://wiki.videolan.org/CoC) applies to this project.
+
+## Support
+
+You can have a direct access to VideoLAN support [here](https://www.videolan.org/support/)



View it on GitLab: https://code.videolan.org/videolan/libdvdnav/-/compare/ee31c2006852ea8640d11195f08a8f13519abc0f...08062820982cc3baf40e4cab430f2b85dfa8c9d8

-- 
View it on GitLab: https://code.videolan.org/videolan/libdvdnav/-/compare/ee31c2006852ea8640d11195f08a8f13519abc0f...08062820982cc3baf40e4cab430f2b85dfa8c9d8
You're receiving this email because of your account on code.videolan.org.


VideoLAN code repository instance