Rename file to README.adoc in order to allow Github to automatically render the file when displaying it at repository's page.
Translate markdown to asciidoctor. It's not a big change, but it includes some formatting like source code highlighting. Remove some future tense used in the text, and fixed some other sentences. Signed-off-by: Daiane Angolini <[email protected]> --- README | 67 ------------------------------------------------------------- README.adoc | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 67 deletions(-) delete mode 100644 README create mode 100644 README.adoc diff --git a/README b/README deleted file mode 100644 index 13530c7..0000000 --- a/README +++ /dev/null @@ -1,67 +0,0 @@ -Freescale's Community Yocto BSP -=============================== - -To get the BSP you need to have `repo` installed and use it as: - -Install the `repo` utility: - -$: mkdir ~/bin -$: curl http://commondatastorage.googleapis.com/git-repo-downloads/repo > ~/bin/repo -$: chmod a+x ~/bin/repo - -Download the BSP source: - -$: PATH=${PATH}:~/bin -$: mkdir fsl-community-bsp -$: cd fsl-community-bsp -$: repo init -u https://github.com/Freescale/fsl-community-bsp-platform -b daisy -$: repo sync - -Once this has completed, you will have all you need. To start a build, do: - -$: source ./setup-environment build -$: bitbake core-image-minimal - -You can use any directory to host your build. - -The source code will be checked out at fsl-community-bsp/sources. - -Contributing ------------- - -To contribute to this layer you should send the patches for review to the -mailing list. - -Mailing list: - - https://lists.yoctoproject.org/listinfo/meta-freescale - -Source code: - - https://github.com/Freescale/fsl-community-bsp-platform - -When creating patches, please use something like: - -git format-patch -s --subject-prefix='fsl-community-bsp-platform][PATCH' origin - -When sending patches, please use something like: - -git send-email --to [email protected] <generated patch> - -Using Development and Testing Branches --------------------------------------- - -Replace the 'repo init' command above with one of the following: - -master: for developers - -$: repo init -u https://github.com/Freescale/fsl-community-bsp-platform -b master - -master-next: for intrepid developers and testers - -Patches are typically merged into master-next and then are merged into -master after a testing and comment period. It's possible that master-next -has something you want or need. But it's also possible that using -master-next will break something that was working before. Use with caution. - -$: repo init -u https://github.com/Freescale/fsl-community-bsp-platform -b master-next diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..1030bcc --- /dev/null +++ b/README.adoc @@ -0,0 +1,67 @@ += FSL Community BSP + +To get the BSP you need to have `repo` installed and use it as: + +Install the `repo` utility: + +[source,console] +$: mkdir ~/bin +$: curl http://commondatastorage.googleapis.com/git-repo-downloads/repo > ~/bin/repo +$: chmod a+x ~/bin/repo + +Download the BSP source: + +[source,console] +$: PATH=${PATH}:~/bin +$: mkdir fsl-community-bsp +$: cd fsl-community-bsp +$: repo init -u https://github.com/Freescale/fsl-community-bsp-platform -b daisy +$: repo sync + +At the end of the commands you have every metadata you need to start work with. + +To start a simple image build: + +[source,console] +$: source ./setup-environment build +$: bitbake core-image-minimal + +You can use any directory to host your build. + +The source code is checked out at `fsl-community-bsp/sources`. + +== Contributing + +To contribute to this layer you should send the patches for review to the mailing list. + +Mailing list:: + https://lists.yoctoproject.org/listinfo/meta-freescale + +Source code:: + https://github.com/Freescale/fsl-community-bsp-platform + +When creating patches, please use something like: + +[source,console] +$: git format-patch -s --subject-prefix='fsl-community-bsp-platform][PATCH' origin + +When sending patches, please use something like: + +[source,console] +$: git send-email --to [email protected] <generated patch> + +== Using Development and Testing Branches + +Replace the `repo init` command above with one of the following: + +master:: For developers ++ +[source,console] +$: repo init -u https://github.com/Freescale/fsl-community-bsp-platform -b master + +master-next:: For intrepid developers and testers ++ +Patches are typically merged into master-next and then are merged into master after a testing and comment period. It's possible that master-next has something you want or need. But it's also possible that using master-next breaks something that was working before. Use with caution. + +[source,console] +$: repo init -u https://github.com/Freescale/fsl-community-bsp-platform -b master-next -- 1.9.1 -- _______________________________________________ meta-freescale mailing list [email protected] https://lists.yoctoproject.org/listinfo/meta-freescale
