forked from go-gitea/gitea
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add build instruction in README, reorganize some sections (go-gitea#3257
) * Add build instruction in README, reorganize some sections * Add link to https://docs.gitea.io/en-us/install-from-source/
- Loading branch information
Showing
1 changed file
with
26 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 **[email protected]**. 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 **[email protected]**. 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 | ||
|
||
|