[vlmc-devel] Rework README

Felix Paul Kühne git at videolan.org
Tue Mar 1 12:44:04 CET 2016


vlmc | branch: master | Felix Paul Kühne <fkuehne at videolan.org> | Tue Mar  1 12:43:58 2016 +0100| [c77547aabe450cf714b8cbcd8a5ebe1ccdca4790] | committer: Felix Paul Kühne

Rework README

> https://code.videolan.org/videolan/vlmc/commit/c77547aabe450cf714b8cbcd8a5ebe1ccdca4790
---

 README    | 48 ------------------------------------------------
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 45 insertions(+), 48 deletions(-)

diff --git a/README b/README
deleted file mode 100644
index f3654f7..0000000
--- a/README
+++ /dev/null
@@ -1,48 +0,0 @@
-README for the VideoLan Movie Creator (VLMC)
-============================================
-
-The VLMC web site . . . . . http://trac.videolan.org/vlmc/
-Bug Report (Trac) . . . . . http://trac.videolan.org/vlmc/report
-Download  . . . . . . . . . http://trac.videolan.org/vlmc/wiki/Downloads
-Wiki  . . . . . . . . . . . http://wiki.videolan.org/VLMC
-Git Repository  . . . . . . git://git.videolan.org/vlmc.git
-
-AUTHORS            - Main VLMC authors.
-CMakeLists.txt     - Root CMake config file.
-COPYING            - The GPL license.
-ChangeLog          - One day, VLMC will have this file.
-HACKING            - Hacking VLMC.
-INSTALL            - General Installation instructions.
-INSTALL.macosx     - Installation instructions for Mac OSX version of VLMC.
-INSTALL.win32      - Installation instructions for the Win32 version of VLMC.
-NEWS               - Important modifications between the releases.
-README             - This file.
-ressources.qrc     - Qt resource file of VLMC.
-THANKS             - All VLMC contributors.
-TRANSLATORS        - VLMC Translators.
-bin/               - Binary files.
-cmake/             - CMake build system configuration.
-contribs/          - Holds libs etc.
-doc/               - Miscellaneous documentation.
-include/           - Include files.
-nsis/              - NSIS config file for building Win32 Installer of VLMC.
-resources/         - VLMC resources folder (images etc.).
-share/             - Common Resources files.
-src/               - VLMC source code.
-ts/                - languages related files.
-
-Building
-========
-
-See the INSTALL file for installation instructions.
-
-Support
-=======
-
-Mailing-list
-	VLMC Developer  <vlmc-devel at videolan.org>
-  VLMC Announment <vlmc-announce at videolan.org>
-  Translators     <translators at videolan.org>
-
-IRC
-	Channel #vlmc on Freenode.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a2bb243
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# VideoLan Movie Creator (VLMC)
+
+VideoLAN Movie Creator is a non-linear editing software for video creation based on libVLC and running on Windows, Linux and Mac OS X! It is a free and open source software distributed under the terms of the [GPLv2].
+
+## Contribute!
+
+As VLMC is an open-source project hosted by VideoLAN, we happily welcome all kinds of contributions to it. For detailed information on the development process, please read our wiki page on [how to send patches].
+
+## Support
+* [Development mailing-list] <vlmc-devel at videolan.org>
+* IRC Channel: #vlmc on the [freenode] network. Use the [Freenode Web] interface, if you don't have an IRC client at hand.
+
+## Building
+See the INSTALL file for compilation and installation instructions.
+
+## Special files and folders
+AUTHORS            - Main VLMC authors.
+CMakeLists.txt     - Root CMake config file.
+COPYING            - The GPL license.
+ChangeLog          - One day, VLMC will have this file.
+HACKING            - Hacking VLMC.
+INSTALL            - General Installation instructions.
+INSTALL.macosx     - Installation instructions for the Mac OS X version of VLMC.
+INSTALL.win32      - Installation instructions for the Win32 version of VLMC.
+NEWS               - Important modifications between the releases.
+README             - This file.
+ressources.qrc     - Qt resource file of VLMC.
+THANKS             - All VLMC contributors.
+TRANSLATORS        - VLMC Translators.
+bin/               - Binary files.
+cmake/             - CMake build system configuration.
+contribs/          - Holds libs etc.
+doc/               - Miscellaneous documentation.
+include/           - Include files.
+nsis/              - NSIS config file for building Win32 Installer of VLMC.
+resources/         - VLMC resources folder (images etc.).
+share/             - Common Resources files.
+src/               - VLMC source code.
+ts/                - languages related files.
+
+   [GPLv2]: <https://opensource.org/licenses/GPL-2.0>
+   [freenode]: <http://www.freenode.net/>
+   [Freenode Web]: <http://webchat.freenode.net/>
+   [how to send patches]: <https://wiki.videolan.org/Sending_Patches_VLC/>
+   [Development mailing-list]: https://mailman.videolan.org/listinfo/vlmc-devel



More information about the Vlmc-devel mailing list