Skip to content

Commit 8052728

Browse files
Update readme.adoc with brief information and link to pkg.teragrep.com (#4)
* Update readme with brief information and link to pkg.teragrep.com * Link Teragrep to main GitHub page
1 parent 59b663e commit 8052728

1 file changed

Lines changed: 3 additions & 42 deletions

File tree

README.adoc

Lines changed: 3 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,8 @@
1-
// Before publishing your new repository:
2-
// 1. Write the readme file
3-
// 2. Update the issues link in Contributing section in the readme file
4-
// 3. Update the discussion link in config.yml file in .github/ISSUE_TEMPLATE directory
1+
= Teragrep DNF Package Repository
52

6-
= repo-template
3+
This is a DNF package repository for https://github.com/teragrep/[Teragrep] releases.
74

8-
// Add a short description of your project. Tell what your project does and what it's used for.
9-
10-
This is a template repository for Teragrep organization.
11-
12-
== Features
13-
14-
// List your project's features
155

166
== Documentation
177

18-
See the official documentation on https://docs.teragrep.com[docs.teragrep.com].
19-
20-
== Limitations
21-
22-
// If your project has limitations, please list them. Otherwise remove this section.
23-
24-
== How to [compile/use/implement]
25-
26-
// add instructions how people can start to use your project
27-
28-
== Contributing
29-
30-
// Change the repository name in the issues link to match with your project's name
31-
32-
You can involve yourself with our project by https://github.com/teragrep/repo-template/issues/new/choose[opening an issue] or submitting a pull request.
33-
34-
Contribution requirements:
35-
36-
. *All changes must be accompanied by a new or changed test.* If you think testing is not required in your pull request, include a sufficient explanation as why you think so.
37-
. Security checks must pass
38-
. Pull requests must align with the principles and http://www.extremeprogramming.org/values.html[values] of extreme programming.
39-
. Pull requests must follow the principles of Object Thinking and Elegant Objects (EO).
40-
41-
Read more in our https://github.com/teragrep/teragrep/blob/main/contributing.adoc[Contributing Guideline].
42-
43-
=== Contributor License Agreement
44-
45-
Contributors must sign https://github.com/teragrep/teragrep/blob/main/cla.adoc[Teragrep Contributor License Agreement] before a pull request is accepted to organization's repositories.
46-
47-
You need to submit the CLA only once. After submitting the CLA you can contribute to all Teragrep's repositories.
8+
See the official documentation on https://pkg.teragrep.com/[https://pkg.teragrep.com/].

0 commit comments

Comments
 (0)