OrgACRN
/
sof
mirror of https://github.com/thesofproject/sof.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
sof/README.md

28 lines
1.1 KiB
Markdown
Raw Normal View History

Move towards modern markdown README Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2018-09-06 05:38:52 +08:00
# Sound Open Firmware
### Status
.github: rename workflow from "Github Action CI" to "Github Actions" The singular "Action" makes it look like our workflow is an action. The plural "Github Actions" is at least the name of the product; so it's vague enough. A technically acccurate name would be "Main workflow" but we have only one so it would be useless plus we're next to "Jenkins" and others and want to stay consistent with them. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2021-01-28 10:24:55 +08:00
[![GitHub Actions](https://github.com/thesofproject/sof/workflows/GitHub%20Actions/badge.svg)](https://github.com/thesofproject/sof/actions)
README.md: fix Travis badge not to show the random PR of the moment As discussed in PR #2964, the Travis badge shows the status of the master branch but it links to the random PR of the moment. Fix that link to point to the more useful "branches" page which has the master branch at the top. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2020-06-06 11:30:15 +08:00
[![Build Status](https://travis-ci.org/thesofproject/sof.svg?branch=master)](https://travis-ci.org/thesofproject/sof/branches)
Readme: add gitter badge Add badge to make finding the chat room a bit easier Signed-off-by: Curtis Malainey <cujomalainey@chromium.org>
2020-05-21 03:48:18 +08:00
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/thesofproject/community)
README: Add IRC badge This will help people reach #sof IRC channel easier. Clicking on the badge will allow people to join IRC chat via irccloud webclient or prompt for their local IRC client. Signed-off-by: Daniel Baluta <daniel.baluta@nxp.com>
2020-05-21 18:46:34 +08:00
[![IRC chat](https://img.shields.io/badge/IRC-%23sof-1e72ff.svg)](https://www.irccloud.com/invite?channel=%23sof&hostname=irc.freenode.net&port=6697&ssl=1)
Move towards modern markdown README Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2018-09-06 05:38:52 +08:00
Add docs link to README Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2018-09-06 05:53:24 +08:00
### Documentation
See [docs](https://thesofproject.github.io/latest/index.html)
Move towards modern markdown README Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2018-09-06 05:38:52 +08:00
## Running the tests
Add link to unit testing documentation Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2018-09-06 05:57:37 +08:00
See [unit testing documentation](https://thesofproject.github.io/latest/developer_guides/unit_tests.html)
Move towards modern markdown README Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2018-09-06 05:38:52 +08:00
## Deployment
readme: update for cmake Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-01-24 00:59:51 +08:00
TODO: Add additional notes about how to deploy this on a live system
Move towards modern markdown README Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2018-09-06 05:38:52 +08:00
## Contributing
readme: update for cmake Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-01-24 00:59:51 +08:00
See [Contributing to the Project](https://thesofproject.github.io/latest/contribute/index.html)
Move towards modern markdown README Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2018-09-06 05:38:52 +08:00
## License
Fix broken LICENSE link Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2018-09-06 05:49:18 +08:00
This project is licensed under the BSD Clause 3 - see the [LICENCE](LICENCE) file for details