Commit graph

5 commits

Author SHA1 Message Date
Amir Sarabadani
35c7a9e1c6 docs: Link to "Local development quickstart" in README
There has a been a lot work and research put to make the best quickstart
possible, it should be advertised more prominently.

Bug: T348899
Change-Id: I1de26d9a1969476afbeb81a5951f24458152e19d
2024-01-22 13:58:11 +00:00
MZMcBride
2dcd56dd10 Fix bullets in README.md
Change-Id: Ib3dd2b9919ad969a3ebb7f1b0952248f4de5c4c1
2022-02-14 19:38:27 -08:00
Timo Tijhof
91822c99dd 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 c0342da8e9.

Change-Id: I79e7e033690abe4de042969826964389ac57fcf6
2020-06-23 15:50:57 +01:00
Legoktm
f7ecc1b5a3 Revert "docs: Rename README to README.md"
This file is parsed in the web installer, which doesn't
understand markdown - it uses the MediaWiki parser.

This reverts commit c0342da8e9.

Bug: T196607
Change-Id: If35f0212dafa80afe59c019ab25b875cd0977fc8
2018-06-07 06:53:59 +00:00
Timo Tijhof
c0342da8e9 docs: Rename README to README.md
The only wikitext-speficic syntax in here is the title.

Renaming this to Markdown has various benefits:

* Makes the README render properly on Gitiles, Doxygen, and Diffusion.
  The current README is not renderable in Gitiles or Doxygen.

* More familiar to new contributors in open-source.

* Consistent with other documentation content we maintain within Git,
  including all PHP and JS documentation, which via JSDoc/JSDuck/Doxygen
  have all their descriptions parsed in Markdown.

* Rich previews and syntax highlighting in many text editors
  and Git viewers.

Change-Id: I5bade76528fa3d870334d960c39db009644bb58f
2018-05-10 15:56:39 +01:00
Renamed from README (Browse further)