diff options
| author | Bryn M. Reeves <bmr@redhat.com> | 2014-07-15 22:23:11 +0100 |
|---|---|---|
| committer | Bryn M. Reeves <bmr@redhat.com> | 2014-07-15 22:23:11 +0100 |
| commit | b7e12554071939329969759f6fcfcb2da031313a (patch) | |
| tree | 613f32e3784edb40262de2501fabb72a7c3356e5 /README.md | |
| parent | 191395594b26268de4cb1711f8b9fa60c431c88d (diff) | |
| download | sos-b7e12554071939329969759f6fcfcb2da031313a.tar.gz | |
[docs] Improve README.md formatting
Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 6 insertions, 4 deletions
@@ -1,5 +1,7 @@ [](https://travis-ci.org/sosreport/sos) +# SoS + Sos is an extensible, portable, support data collection tool primarily aimed at Linux distributions and other UNIX-like operating systems. @@ -15,23 +17,23 @@ To clone the current master (development) branch run: ``` git clone git://github.com/sosreport/sos.git ``` -### Reporting bugs +## Reporting bugs Please report bugs via the mailing list or by opening an issue in the [GitHub Issue Tracker][5] -### Mailing list +## Mailing list The [sos-devel][4] mailing list is used to discussi sos development and reviewing patches. User questions and general discussion are welcome too. -### Contributing +## Developers Patches can be submitted via the mailing list or as GitHub pull requests. If using GitHub please make sure your branch applies to the current master as a 'fast forward' merge (i.e. without creating a merge commit). Use the `git rebase` command to update your branch to the current master if necessary. -Wiki documentation +### Wiki documentation * [How to write a plugin][1] * [How to write a policy][2] |