From cfa1638e3cc2189a1435b0a67ce967336bb56885 Mon Sep 17 00:00:00 2001 From: ziggystar Date: Wed, 24 Feb 2021 22:53:09 +0100 Subject: [PATCH] Update README.md (#2694) ## Developer information is hard to find I've been looking for instructions on how to build gitbucket a couple of times, and I've never found them until takzoe pointed me towards `doc/build.md`. After knowing about this, I read through the readme once again, looking for such a link, and then I've found it as the last sentence within a section named `Features`. What I've been looking for: - either a file named `INSTALL.md`, `BUILD.md` in `/` - or a section (or a link) in the main readme I've put the link to `doc/readme.md` into a separate section "Building and Development" and added a short summary. I'm not so sure about the order of the new section and "Plugins". --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 269d9afc8..29ed474a6 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,6 @@ The current version of GitBucket provides many features such as: - Account and group management with LDAP integration - a Plug-in system -If you want to try the development version of GitBucket, see the [Developer's Guide](https://github.com/gitbucket/gitbucket/blob/master/doc/readme.md). - Installation -------- GitBucket requires **Java8**. You have to install it, if it is not already installed. @@ -50,6 +48,12 @@ GitBucket has a plug-in system that allows extra functionality. Officially the f You can find more plugins made by the community at [GitBucket community plugins](https://gitbucket-plugins.github.io/). +Building and Development +----------- +If you want to try the development version of GitBucket, or want to contribute to the project, please see the [Developer's Guide](https://github.com/gitbucket/gitbucket/blob/master/doc/readme.md). +It provides instructions on building from source and on setting up an IDE for debugging. +It also contains documentation of the core concepts used within the project. + Support --------