[vlmc-devel] Move INSTALL docs to md

Felix Paul Kühne git at videolan.org
Thu Mar 3 17:41:18 CET 2016


vlmc | branch: master | Felix Paul Kühne <fkuehne at videolan.org> | Thu Mar  3 17:41:12 2016 +0100| [1079e9f66420fef4ec494de0f5041e3514f5efcb] | committer: Felix Paul Kühne

Move INSTALL docs to md

> https://code.videolan.org/videolan/vlmc/commit/1079e9f66420fef4ec494de0f5041e3514f5efcb
---

 CMakeLists.txt                    |  2 +-
 INSTALL => INSTALL.md             | 30 +++++++++++-------------------
 INSTALL.win32 => INSTALL.win32.md | 15 +++++----------
 3 files changed, 17 insertions(+), 30 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 9d37cf6..1147071 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -234,7 +234,7 @@ SUBDIRS(nsis)
 SUBDIRS(effects)
 
 # Copy stuff to doc subdirectory
-INSTALL (FILES AUTHORS COPYING INSTALL NEWS README.md THANKS TRANSLATORS
+INSTALL (FILES AUTHORS COPYING INSTALL.md NEWS README.md THANKS TRANSLATORS
          DESTINATION ${VLMC_DOC_DIR})
 
 # Copy .desktop file
diff --git a/INSTALL b/INSTALL.md
similarity index 64%
rename from INSTALL
rename to INSTALL.md
index 4f2071a..05b782e 100644
--- a/INSTALL
+++ b/INSTALL.md
@@ -1,18 +1,14 @@
-Building VLMC
+# Building VLMC
 
-Dependencies
-============
+## Dependencies
+* Latest version of VLC installed (from the git repository)
+* Qt framework >= 4.5.0
 
-- Latest version of VLC installed (from the git repository)
-- Qt framework >= 4.5.0
-
-Get the sources
-===============
+##Get the sources
 
   git clone https://code.videolan.org/videolan/vlmc.git
 
-Building and packaging VLMC on Linux
-====================================
+##Building and packaging VLMC on Linux
 
 A typical way to build VLMC is:
   mkdir build && cd build
@@ -36,26 +32,22 @@ To force building deb:
 To force building rpm:
   cpack -G RPM
    
-Installing on Linux
-===================
+## Installing on Linux
 
-On Linux:
+### To install
   dpkg -i <deb package>
   rpm -i <rpm package>
 
-To remove:
+### To remove:
   dpkg -r vlmc
   rpm -e vlmc
 
 
-Running VLMC
-============
+## Running VLMC
 
 	./vlmc
 
-Issues
-======
+## Issues
 
 If you run into problems, you can ask for help on <vlmc-devel at videolan.org> and
 IRC channel #vlmc on Freenode.
-
diff --git a/INSTALL.win32 b/INSTALL.win32.md
similarity index 67%
rename from INSTALL.win32
rename to INSTALL.win32.md
index acee36e..3601a1e 100644
--- a/INSTALL.win32
+++ b/INSTALL.win32.md
@@ -1,23 +1,18 @@
-Cross-compilation (from Unix)
-=============================
+# Cross-compilation (from Unix)
 
-Get Contribs
-------------
+## Get Contribs
  cd contribs
  sh contribs.sh
 
-Configure
----------
+## Configure
 mkdir win32 && cd win32
 cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/toolchain-win32.cmake ..
 
 Use -D flag to set cmake flags such as:
 cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/toolchain-win32.cmake -DQT_MOC_EXECUTABLE=../contribs/tools/moc.exe ..
 
-Build
------
+## Build
 make
 
-Package It
-----------
+## Package It
 make installer



More information about the Vlmc-devel mailing list