| commit | f92f94337ab3783edd2a437053c583b9d5f92441 | [log] [tgz] |
|---|---|---|
| author | Andrew Jeffery <andrew@aj.id.au> | Thu May 31 13:59:46 2018 +0930 |
| committer | Andrew Jeffery <andrew@aj.id.au> | Thu May 31 13:59:46 2018 +0930 |
| tree | d3e77c6dcbf8f1682d0b175b7bf73de18c435e8b | |
| parent | c8f75c53579ef315da7024e4f91a21977ce3fa2c [diff] |
README: Update to reflect the current nature of openbmc-tools Having scooped up most of the useful scripts, it's time to start documenting what we've got and doing some housekeeping. Make the README a bit more mature to reflect this. Change-Id: Icc06b7ffa58d413ea7f9abb334a203dc9084878d Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
The goal of this repository is to collect the two-minute hacks you write to automate interactions with OpenBMC systems.
It's highly likely the scripts don't meet your needs - they could be undocumented, dysfunctional or utterly broken. Please help us improve!
Then this repository aims to be the default destination for your otherwise un-homed scripts. As such we are setting the bar for submission pretty low, and we aim to make the process as easy as possible:
However you want to send patches, we will probably cope:
Do note that you will need to be party to the OpenBMC CLA before your contributions can be accepted.
So long as your patches look sane with a cursory glance you can expect them to be applied. We may push back in the event that similar tools already exist or there are egregious issues.
We don't ask for much, but you need to give us at least a Signed-off-by, and put your work under the Apache 2.0 license. Licensing everything under Apache 2.0 will just hurt our heads less. Lets keep the lawyers off our backs. ^
^Any exceptions must be accompanied by a LICENSE file in the relevant subdirectory, and be compatible with Apache 2.0. You thought you would get away without any fine print?
There's no standard way to install the scripts housed in the here, so adding parts of the repository to your PATH might be a bit of a dice-roll. We may also move or remove scripts from time to time as part of housekeeping. It's probably best to copy things out if you need stability.