From 689c31f418f033c4051d5b6ddb76e0e3381b77d9 Mon Sep 17 00:00:00 2001 From: Bin Meng Date: Mon, 21 Jan 2019 22:14:16 +0800 Subject: [PATCH] top: Fix broken links in top-level README.md There are 2 markdown links that are currently broken in top-level README.md. Fix them so that github could render the URL correctly. This also fixes "No newline at end of file" warning. Signed-off-by: Bin Meng --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f629046..1e0152d 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ License ------------- The software is provided under a BSD-2-Clause license. Contributions to this project are accepted under the same license with developer sign-off as -described in the [Contributing Guidelines] [docs/contributing.md]. +described in the [Contributing Guidelines](docs/contributing.md). This project also contains code from other projects as listed below. The original license text is included in those source files. @@ -109,10 +109,11 @@ as follows. * *`docs/firmware/.md`* - Documentation for the firmware ** The source code is also well documented. For source level documentation, -doxygen style is used. Please refer to [Doxygen manual] -(http://www.stack.nl/~dimitri/doxygen/manual.html) for details on this +doxygen style is used. Please refer to [Doxygen manual] for details on this format. +[Doxygen manual]: http://www.stack.nl/~dimitri/doxygen/manual.html + The Doxygen can be installed on your debian build system using following: ``` sudo apt-get install doxygen doxygen-latex doxygen-doc doxygen-gui graphviz @@ -134,4 +135,4 @@ or make I= install_docs ``` -**NOTE:** `refman.pdf` will be installed under `/docs`. \ No newline at end of file +**NOTE:** `refman.pdf` will be installed under `/docs`. -- 2.7.4