From c52dc7ce48c0f1fd9f201245663618346cbfc84c Mon Sep 17 00:00:00 2001 From: Curtis Malainey Date: Wed, 5 Sep 2018 14:38:52 -0700 Subject: [PATCH 1/4] Move towards modern markdown README Signed-off-by: Curtis Malainey --- README | 33 ------------------------------- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+), 33 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index c2ac1ca1d803..000000000000 --- a/README +++ /dev/null @@ -1,33 +0,0 @@ - -Build Instructions - -1) Run "autogen.sh" - -2) Build and install the rimage ELF image creator and signing tool - -./configure --enable-rimage -make -sudo make install - -3) Run the following configure based on your platform. - -Baytrail :- - -./configure --with-arch=xtensa --with-platform=baytrail --with-root-dir=$PWD/../xtensa-root/xtensa-byt-elf --host=xtensa-byt-elf - -Cherrytrail :- - -./configure --with-arch=xtensa --with-platform=cherrytrail --with-root-dir=$PWD/../xtensa-root/xtensa-byt-elf --host=xtensa-byt-elf - -Library for Host Platform :- -If building library for host platform, run the following configure. Please modify -the --prefix option to choose the directory for installing the library files and -headers - -./configure --with-arch=host --enable-library=yes --host=x86_64-unknown-linux-gnu --prefix=$PWD/../host-root/ - -4) make - -5) make bin - - diff --git a/README.md b/README.md new file mode 100644 index 000000000000..79cc0e1a88db --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# Sound Open Firmware + +### Status +[![Build Status](https://travis-ci.org/thesofproject/sof.svg?branch=master)](https://travis-ci.org/thesofproject/sof) + +### Prerequisites + +* Docker + +### Build Instructions + +1. Run `autogen.sh` + +2. Build and install the rimage ELF image creator and signing tool + +``` +./configure --enable-rimage +make +sudo make install +``` + +3. Run the following configure based on your platform. + +Baytrail :- + +`./configure --with-arch=xtensa --with-platform=baytrail --with-root-dir=$PWD/../xtensa-root/xtensa-byt-elf --host=xtensa-byt-elf` + +Cherrytrail :- + +`./configure --with-arch=xtensa --with-platform=cherrytrail --with-root-dir=$PWD/../xtensa-root/xtensa-byt-elf --host=xtensa-byt-elf` + +Library for Host Platform :- +If building library for host platform, run the following configure. Please modify +the --prefix option to choose the directory for installing the library files and +headers + +`./configure --with-arch=host --enable-library=yes --host=x86_64-unknown-linux-gnu --prefix=$PWD/../host-root/` + +4. `make` + +5. `make bin` + +End with an example of getting some data out of the system or using it for a little demo + +## Running the tests + +TODO + +## Deployment + +Add additional notes about how to deploy this on a live system + +## Contributing + +TODO? + +## License + +This project is licensed under the BSD Clause 3 - see the [LICENSE.md](LICENSE.md) file for details From 5a1f69391218b1177895d66897e5cec8f2a7c63a Mon Sep 17 00:00:00 2001 From: Curtis Malainey Date: Wed, 5 Sep 2018 14:49:18 -0700 Subject: [PATCH 2/4] Fix broken LICENSE link Signed-off-by: Curtis Malainey --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 79cc0e1a88db..ac275fd62de5 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,11 @@ sudo make install Baytrail :- -`./configure --with-arch=xtensa --with-platform=baytrail --with-root-dir=$PWD/../xtensa-root/xtensa-byt-elf --host=xtensa-byt-elf` +```./configure --with-arch=xtensa --with-platform=baytrail --with-root-dir=$PWD/../xtensa-root/xtensa-byt-elf --host=xtensa-byt-elf``` Cherrytrail :- -`./configure --with-arch=xtensa --with-platform=cherrytrail --with-root-dir=$PWD/../xtensa-root/xtensa-byt-elf --host=xtensa-byt-elf` +```./configure --with-arch=xtensa --with-platform=cherrytrail --with-root-dir=$PWD/../xtensa-root/xtensa-byt-elf --host=xtensa-byt-elf``` Library for Host Platform :- If building library for host platform, run the following configure. Please modify @@ -56,4 +56,4 @@ TODO? ## License -This project is licensed under the BSD Clause 3 - see the [LICENSE.md](LICENSE.md) file for details +This project is licensed under the BSD Clause 3 - see the [LICENCE](LICENCE) file for details From 5c6b62ef8ed1e979858a66ae7cdf5413cdfa1a14 Mon Sep 17 00:00:00 2001 From: Curtis Malainey Date: Wed, 5 Sep 2018 14:53:24 -0700 Subject: [PATCH 3/4] Add docs link to README Signed-off-by: Curtis Malainey --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index ac275fd62de5..f8186ee4e619 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ ### Status [![Build Status](https://travis-ci.org/thesofproject/sof.svg?branch=master)](https://travis-ci.org/thesofproject/sof) +### Documentation + +See [docs](https://thesofproject.github.io/latest/index.html) + ### Prerequisites * Docker From ea4cd1fbd4211db318663128acd03850f7feed76 Mon Sep 17 00:00:00 2001 From: Curtis Malainey Date: Wed, 5 Sep 2018 14:57:37 -0700 Subject: [PATCH 4/4] Add link to unit testing documentation Signed-off-by: Curtis Malainey --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f8186ee4e619..cbde03ae74fb 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ End with an example of getting some data out of the system or using it for a lit ## Running the tests -TODO +See [unit testing documentation](https://thesofproject.github.io/latest/developer_guides/unit_tests.html) ## Deployment