[Kimchi-devel] [PATCH v2] Display "README" with markdown style on Github

Crístian Viana vianac at linux.vnet.ibm.com
Fri Oct 3 21:34:37 UTC 2014


The file "README" is a markdown file but as it doesn't have the suffix
".md", Github doesn't render it with markdown style.

Rename the symlink "README" in order to be displayed with markdown style
on Github. Also, tell Automake not to look for a file called "README".

Signed-off-by: Crístian Viana <vianac at linux.vnet.ibm.com>
---
 Makefile.am | 2 ++
 README      | 1 -
 README.md   | 1 +
 3 files changed, 3 insertions(+), 1 deletion(-)
 delete mode 120000 README
 create mode 120000 README.md

diff --git a/Makefile.am b/Makefile.am
index 3293d9e..65fbc97 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -25,6 +25,8 @@ else
 DEFINE_FONTS = --define "with_fonts 0"
 endif
 
+AUTOMAKE_OPTIONS = foreign
+
 ACLOCAL_AMFLAGS = --install -I m4
 
 EXTRA_DIST = \
diff --git a/README b/README
deleted file mode 120000
index 0e01b43..0000000
--- a/README
+++ /dev/null
@@ -1 +0,0 @@
-docs/README.md
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 120000
index 0000000..0e01b43
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+docs/README.md
\ No newline at end of file
-- 
1.9.3




More information about the Kimchi-devel mailing list