Permalink
Browse files

Make clear to the reader why we are using a *.md file in a parrot repo.

  • Loading branch information...
1 parent 61c92f6 commit 13f50360d15efd7079420d5960b1925560e75c04 @ayardley ayardley committed Jul 9, 2012
Showing with 9 additions and 0 deletions.
  1. +9 −0 README.md
View
@@ -11,6 +11,15 @@ correct any errors in the documentation.
So, everyone, feel free to contribute!
+# NOTE
+
+As a rule, the Parrot team does not use the markdown format in Parrot's
+repositories. We use pod. We have made an exception in this instance because
+of a conflict between our 'README.pod' file and the contents of this readme,
+and because github renders markdown before all other formats. This enables
+us to display the above "DESCRIPTION" to users, rather than the contents of
+'README.pod'.
+
# COPYRIGHT
Copyright (C) 2011-2012, Parrot Foundation.

0 comments on commit 13f5036

Please sign in to comment.