aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTimo Tijhof <krinklemail@gmail.com>2020-06-23 15:44:53 +0100
committerTimo Tijhof <krinklemail@gmail.com>2020-06-23 15:50:57 +0100
commit91822c99dd20fa4a5f9b7f3f9719536528f0b4d7 (patch)
tree4662db6ccceccbfde3a1cf37de96e214885a0994
parent52f1bfa61bcc3557a0a8f5e5782f659be25a90f5 (diff)
downloadmediawikicore-91822c99dd20fa4a5f9b7f3f9719536528f0b4d7.tar.gz
mediawikicore-91822c99dd20fa4a5f9b7f3f9719536528f0b4d7.zip
docs: Rename main README to README.md
* Match the other doc files we maintain in Git under docs/ and for individual components, as well as all inline docs for PHP and JS documentation render as Markdown via JSDoc/JSDuck/Doxygen. This was currently the only prominent 'wikitext'-ish documentation file. Although the only wikitext-speficic syntax here was the heading. * The current README was not shown at all in Gitiles as it requires the README to have a file extension, and it does not support '.mediawiki'. Follows-up c0342da8e9a675. Change-Id: I79e7e033690abe4de042969826964389ac57fcf6
-rw-r--r--.gitattributes1
-rw-r--r--README.md (renamed from README)2
l---------README.mediawiki1
-rw-r--r--tests/phpunit/documentation/ReleaseNotesTest.php1
4 files changed, 1 insertions, 4 deletions
diff --git a/.gitattributes b/.gitattributes
index 884befbf68d8..6e715317c576 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -7,7 +7,6 @@
.* export-ignore
*.htaccess -export-ignore
package.json export-ignore
-README.mediawiki export-ignore
Gemfile* export-ignore
vendor/pear/net_smtp/README.rst export-ignore
phpunit.xml.dist export-ignore
diff --git a/README b/README.md
index ad9b9d9d837a..12337e6d0737 100644
--- a/README
+++ b/README.md
@@ -1,4 +1,4 @@
-== MediaWiki ==
+# MediaWiki
MediaWiki is a free and open-source wiki software package written in PHP. It
serves as the platform for Wikipedia and the other Wikimedia projects, used
diff --git a/README.mediawiki b/README.mediawiki
deleted file mode 120000
index 100b93820ade..000000000000
--- a/README.mediawiki
+++ /dev/null
@@ -1 +0,0 @@
-README \ No newline at end of file
diff --git a/tests/phpunit/documentation/ReleaseNotesTest.php b/tests/phpunit/documentation/ReleaseNotesTest.php
index 6976e604a606..efd8cbf1d572 100644
--- a/tests/phpunit/documentation/ReleaseNotesTest.php
+++ b/tests/phpunit/documentation/ReleaseNotesTest.php
@@ -42,7 +42,6 @@ class ReleaseNotesTest extends MediaWikiTestCase {
"FAQ",
"HISTORY",
"INSTALL",
- "README",
"SECURITY",
];