aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: Link to "Local development quickstart" in READMEAmir Sarabadani2024-01-221-0/+2
| | | | | | | | 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
* Fix bullets in `README.md`MZMcBride2022-02-141-5/+5
| | | | Change-Id: Ib3dd2b9919ad969a3ebb7f1b0952248f4de5c4c1
* docs: Rename main README to README.mdTimo Tijhof2020-06-231-0/+33
| | | | | | | | | | | | | | | | | | * 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
* Revert "docs: Rename README to README.md"Legoktm2018-06-071-34/+0
| | | | | | | | | | This file is parsed in the web installer, which doesn't understand markdown - it uses the MediaWiki parser. This reverts commit c0342da8e9a675ce6803d651a781addb801ef8f3. Bug: T196607 Change-Id: If35f0212dafa80afe59c019ab25b875cd0977fc8
* docs: Rename README to README.mdTimo Tijhof2018-05-101-0/+34
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