Skip to content

Commit 318176f

Browse files
authored
Merge pull request #312 from cujomalainey/master
Move towards modern markdown README
2 parents 62bae33 + ea4cd1f commit 318176f

2 files changed

Lines changed: 63 additions & 33 deletions

File tree

README

Lines changed: 0 additions & 33 deletions
This file was deleted.

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Sound Open Firmware
2+
3+
### Status
4+
[![Build Status](https://travis-ci.org/thesofproject/sof.svg?branch=master)](https://travis-ci.org/thesofproject/sof)
5+
6+
### Documentation
7+
8+
See [docs](https://thesofproject.github.io/latest/index.html)
9+
10+
### Prerequisites
11+
12+
* Docker
13+
14+
### Build Instructions
15+
16+
1. Run `autogen.sh`
17+
18+
2. Build and install the rimage ELF image creator and signing tool
19+
20+
```
21+
./configure --enable-rimage
22+
make
23+
sudo make install
24+
```
25+
26+
3. Run the following configure based on your platform.
27+
28+
Baytrail :-
29+
30+
```./configure --with-arch=xtensa --with-platform=baytrail --with-root-dir=$PWD/../xtensa-root/xtensa-byt-elf --host=xtensa-byt-elf```
31+
32+
Cherrytrail :-
33+
34+
```./configure --with-arch=xtensa --with-platform=cherrytrail --with-root-dir=$PWD/../xtensa-root/xtensa-byt-elf --host=xtensa-byt-elf```
35+
36+
Library for Host Platform :-
37+
If building library for host platform, run the following configure. Please modify
38+
the --prefix option to choose the directory for installing the library files and
39+
headers
40+
41+
`./configure --with-arch=host --enable-library=yes --host=x86_64-unknown-linux-gnu --prefix=$PWD/../host-root/`
42+
43+
4. `make`
44+
45+
5. `make bin`
46+
47+
End with an example of getting some data out of the system or using it for a little demo
48+
49+
## Running the tests
50+
51+
See [unit testing documentation](https://thesofproject.github.io/latest/developer_guides/unit_tests.html)
52+
53+
## Deployment
54+
55+
Add additional notes about how to deploy this on a live system
56+
57+
## Contributing
58+
59+
TODO?
60+
61+
## License
62+
63+
This project is licensed under the BSD Clause 3 - see the [LICENCE](LICENCE) file for details

0 commit comments

Comments
 (0)