git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] gitweb: Show project README if available

From
Petr Baudis <pasky@suse.cz>
Date
Oct 10, 2006, 02:56 UTC
Message-ID
<20061010025627.19317.70511.stgit@rover>

If the project includes a README file, show it in the summary page. The usual "this should be in the config file" argument does not apply here since this can be larger and having such a big string in the config file would be impractical.

I don't know if this is suitable upstream, but it's one of the repo.or.cz custom modifications that I've thought could be interesting for others as well.

Signed-off-by: Petr Baudis <pasky@suse.cz>
---
 gitweb/gitweb.perl |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)
diff --git a/gitweb/gitweb.perl b/gitweb/gitweb.perl
index 7547c4d..4e56af9 100755
--- a/gitweb/gitweb.perl
+++ b/gitweb/gitweb.perl
@@ -2535,6 +2535,14 @@ sub git_summary {
 	}
 	print "</table>\n";
 
+	if (-s "$projectroot/$project/README") {
+		if (open my $fd, "$projectroot/$project/README") {
+			print "<div class=\"title\">readme</div>\n";
+			print $_ while (<$fd>);
+			close $fd;
+		}
+	}
+
 	open my $fd, "-|", git_cmd(), "rev-list", "--max-count=17",
 		git_get_head_hash($project)
 		or die_error(undef, "Open git-rev-list failed");
Next: Junio C Hamano
Message 1 of 14 in “gitweb: Show project README if available”
  1. gitweb: Show project README if availablePetr Baudis, Oct 10, 2006
  2. Junio C HamanoOct 10, 2006
  3. Junio C HamanoOct 10, 2006
  4. Petr BaudisOct 10, 2006
  5. Jakub NarebskiOct 10, 2006
  6. Luben TuikovOct 10, 2006
  7. Andreas EricssonOct 10, 2006
  8. Jakub NarebskiOct 10, 2006
  9. Petr BaudisOct 10, 2006
  10. Jakub NarebskiOct 11, 2006
  11. Jeff KingOct 11, 2006
  12. Jakub NarebskiOct 11, 2006
  13. Junio C HamanoOct 11, 2006
  14. Jakub NarebskiOct 11, 2006

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.