diff options
| author | Sandro Santilli <strk@kbt.io> | 2018-01-01 14:38:49 +0100 |
|---|---|---|
| committer | Lauris BH <lauris@nix.lv> | 2018-01-01 15:38:49 +0200 |
| commit | bccbbcf12e6a4738bd04d1fa7888c0834d61356c (patch) | |
| tree | be6d732fa6e8627d8c105f3a6a470404a5b527e7 /README.md | |
| parent | b05a17249b41a1e202f9a616cfc74f1c2e68994e (diff) | |
| download | gitea-bccbbcf12e6a4738bd04d1fa7888c0834d61356c.tar.gz gitea-bccbbcf12e6a4738bd04d1fa7888c0834d61356c.zip | |
Add build instruction in README, reorganize some sections (#3257)
* Add build instruction in README, reorganize some sections
* Add link to https://docs.gitea.io/en-us/install-from-source/
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 38 |
1 files changed, 26 insertions, 12 deletions
@@ -31,24 +31,38 @@ This project has been [forked](https://blog.gitea.io/2016/12/welcome-to-gitea/) from [Gogs](https://gogs.io) since 2016.11 but changed a lot. -## Notes +## Building -1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.** -2. If you have found a vulnerability in the project, please write privately to **security@gitea.io**. Thanks! -3. If you're interested in using our APIs, we have experimental support with [documentation](https://godoc.org/code.gitea.io/sdk/gitea). +From the root of the source tree, run: -## Docs + make generate all -For more information and instructions about how to install Gitea, please look -at our [documentation](https://docs.gitea.io/en-us/). If you have questions -that are not covered by the documentation, you can get in contact with us on -our [Discord server](https://discord.gg/NsatcWJ), -[Matrix room](https://matrix.to/#/#gitea:matrix.org), -or [forum](https://discourse.gitea.io/)! +More info: https://docs.gitea.io/en-us/install-from-source/ + +## Using + + ./gitea web + +NOTE: If you're interested in using our APIs, we have experimental +support with [documentation](https://godoc.org/code.gitea.io/sdk/gitea). ## Contributing -Fork -> Patch -> Push -> Pull Request +Expected workflow is: Fork -> Patch -> Push -> Pull Request + +NOTES: + +1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.** +2. If you have found a vulnerability in the project, please write privately to **security@gitea.io**. Thanks! + +## Further information + +For more information and instructions about how to install Gitea, please look +at our [documentation](https://docs.gitea.io/en-us/). If you have questions +that are not covered by the documentation, you can get in contact with us on +our [Discord server](https://discord.gg/NsatcWJ), +[Matrix room](https://matrix.to/#/#gitea:matrix.org), +or [forum](https://discourse.gitea.io/)! ## Authors |