summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)AuthorFilesLines
2019-09-05README: Update license informationDamien Le Moal1-8/+4
With the Kendryte K210 platform code cleanup, none of the code copied from Kendryte standalone SDK remains and this platform code is now entirely licensed under OpenSBI BSD-2-clause license. Update the README.md and ThirdPartyNotices.md files to reflect this. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com> Reviewed-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Anup Patel <anup.patel@wdc.com>
2019-07-25treewide: Use conventional names for 32-bit and 64-bitBin Meng1-1/+1
There are several places in the source tree that have: 32bit, 32 bit, 64bit, 64 bit Fix by using the conventional names with a hyphen. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Lukas Auer <lukas.auer@aisec.fraunhofer.de> Acked-by: Anup Patel <anup.patel@wdc.com>
2019-07-25README: Document 32-bit / 64-bit images buildBin Meng1-0/+19
At present the exact details of building 32-bit or 64-bit OpenSBI images are missing in the docs. This adds the missing part. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Lukas Auer <lukas.auer@aisec.fraunhofer.de> Acked-by: Anup Patel <anup.patel@wdc.com>
2019-05-06docs: miscellaneous documentation fixes and updatesKarsten Merker1-50/+53
- fix some broken hyperlinks - add additional hyperlinks to references to external documents - reformat some paragraphs to keep lines under 80 characters - unify the enumeration style between different parts of the documentation - fix spelling/grammar mistakes - extend the copyright notice in README.md to be the same as the one in COPYING.BSD Signed-off-by: Karsten Merker <merker@debian.org> Reviewed-by: Atish Patra <atish.patra@wdc.com>
2019-04-15top: Add CONTRIBUTORS.md fileAnup Pate1-2/+5
We add CONTRIBUTORS.md file to provide a list of individuals and organizations actively contributing to the OpenSBI project. Signed-off-by: Anup Patel <anup.patel@wdc.com>
2019-04-03README: Update license informationDamien Le Moal1-0/+10
Add information regarding the Apache License Version 2.0 of some of the Kendryte/k210 platform files. Also repeat this information in a new ThirdPartyNotices.md file. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-02-19docs: Add a payload section describing different payloads.Atish Patra1-1/+1
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-02-19docs: Update about toolchain section.Atish Patra1-0/+10
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-02-08top: README.md updatesDamien Le Moal1-33/+47
Clarify OpenSBI components explanation. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-01-30top: Fix typo in README.mdAnup Patel1-3/+3
This patch renames <platform_sub_dir> to <platform_subdir> to be consistent everywhere. Signed-off-by: Anup Patel <anup.patel@wdc.com>
2019-01-24docs: README.md updateDamien Le Moal1-67/+131
Reformat to fit lines within 80 chars, fix hyperlinks, etc. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-01-22docs: Typo fixes.Atish Patra1-4/+4
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-01-22top: Fix broken links in top-level README.mdBin Meng1-4/+5
There are 2 markdown links that are currently broken in top-level README.md. Fix them so that github could render the URL correctly. This also fixes "No newline at end of file" warning. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-01-18docs: Add licensing seciton for external projects.Atish Patra1-0/+13
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-01-16top: Update top-level README.md to build/install documentation PDFAnup Patel1-15/+30
This patch updates top-level README.md for steps required to build and install documentation PDF. Signed-off-by: Anup Patel <anup.patel@wdc.com>
2018-12-31top: Minor typo fixes in top-level README.mdAnup Patel1-12/+9
This patch does minor typo fixes in top-level README.md. Signed-off-by: Anup Patel <anup.patel@wdc.com>
2018-12-26top: Rename back CROSS_COMPILE_PREFIX to CROSS_COMPILEAnup Patel1-1/+1
The name CROSS_COMPILE is an industry standard used across open-source project to specify cross-compiler prefix. In fact, distro build systems such as buildroot and yocto assume CROSS_COMPILE to be supported by projects added as packages to these build systems. This patch rename back CROSS_COMPILE_PREFIX to CROSS_COMPILE. Signed-off-by: Anup Patel <anup.patel@wdc.com>
2018-12-25README: UpdateDamien Le Moal1-70/+100
Some rewrite with a more formal style. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2018-12-25Makefile: Rename CROSS_COMPILE to CROSS_COMPILE_PREFIXDamien Le Moal1-3/+4
Make it clear what this environment variable defines and update the README.md file to explain that. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2018-12-22top: Typo fix in top-level README.mdAnup Patel1-1/+1
The platform specific options will be PLATFORM_<xyz> and not PLAT_<xyz> hence this patch fixes typo in top-level README.md. Signed-off-by: Anup Patel <anup.patel@wdc.com>
2018-12-21top: Rename "plat" to "platform" everywhereAnup Patel1-8/+8
This patch renames "plat" to "platform" everywhere for better readablility. Signed-off-by: Anup Patel <anup.patel@wdc.com>
2018-12-21top: Rename "blob" to "firmware" everywhereAnup Patel1-7/+7
This patch renames "blob" to "firmware" everywhere for better and intutive naming. Signed-off-by: Anup Patel <anup@brainfault.org>
2018-12-21top: More detailed top-level README.mdAnup Patel1-21/+65
This patch adds more details to top-level README.md based on current state of OpenSBI. Signed-off-by: Anup Patel <anup.patel@wdc.com>
2018-12-11Initial commit.Anup Patel1-0/+37
Signed-off-by: Anup Patel <anup.patel@wdc.com>