* [RFC][fsl-community-bsp-platform] README: Translate README to use Asciidoctor instead of markdown
@ 2015-01-09 17:39 Daiane Angolini
2015-01-09 17:59 ` Daiane Angolini
0 siblings, 1 reply; 6+ messages in thread
From: Daiane Angolini @ 2015-01-09 17:39 UTC (permalink / raw)
To: meta-freescale
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 <daiane.angolini@freescale.com>
---
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 meta-freescale@yoctoproject.org <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 meta-freescale@yoctoproject.org <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
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [RFC][fsl-community-bsp-platform] README: Translate README to use Asciidoctor instead of markdown
2015-01-09 17:39 [RFC][fsl-community-bsp-platform] README: Translate README to use Asciidoctor instead of markdown Daiane Angolini
@ 2015-01-09 17:59 ` Daiane Angolini
2015-01-09 18:03 ` Eric Nelson
` (2 more replies)
0 siblings, 3 replies; 6+ messages in thread
From: Daiane Angolini @ 2015-01-09 17:59 UTC (permalink / raw)
To: Daiane Angolini; +Cc: meta-freescale@yoctoproject.org
On Fri, Jan 9, 2015 at 3:39 PM, Daiane Angolini
<daiane.angolini@freescale.com> wrote:
> 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 <daiane.angolini@freescale.com>
Please, see the rendered result here
https://github.com/angolini/fsl-community-bsp-platform/blob/master/README.adoc
Does it worth the change?
Otavio, What do you think?
Would be a problem to have the README file renamed to README.adoc?
Daiane
> ---
> 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 meta-freescale@yoctoproject.org <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 meta-freescale@yoctoproject.org <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
> meta-freescale@yoctoproject.org
> https://lists.yoctoproject.org/listinfo/meta-freescale
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [RFC][fsl-community-bsp-platform] README: Translate README to use Asciidoctor instead of markdown
2015-01-09 17:59 ` Daiane Angolini
@ 2015-01-09 18:03 ` Eric Nelson
2015-01-09 18:30 ` Otavio Salvador
2015-01-10 15:07 ` Trevor Woerner
2 siblings, 0 replies; 6+ messages in thread
From: Eric Nelson @ 2015-01-09 18:03 UTC (permalink / raw)
To: Daiane Angolini, Daiane Angolini; +Cc: meta-freescale@yoctoproject.org
On 01/09/2015 10:59 AM, Daiane Angolini wrote:
> On Fri, Jan 9, 2015 at 3:39 PM, Daiane Angolini
> <daiane.angolini@freescale.com> wrote:
>> 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 <daiane.angolini@freescale.com>
>
> Please, see the rendered result here
> https://github.com/angolini/fsl-community-bsp-platform/blob/master/README.adoc
>
> Does it worth the change?
>
I like it and think it's well worth the change.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [RFC][fsl-community-bsp-platform] README: Translate README to use Asciidoctor instead of markdown
2015-01-09 17:59 ` Daiane Angolini
2015-01-09 18:03 ` Eric Nelson
@ 2015-01-09 18:30 ` Otavio Salvador
2015-01-10 15:07 ` Trevor Woerner
2 siblings, 0 replies; 6+ messages in thread
From: Otavio Salvador @ 2015-01-09 18:30 UTC (permalink / raw)
To: Daiane Angolini; +Cc: meta-freescale@yoctoproject.org
On Fri, Jan 9, 2015 at 3:59 PM, Daiane Angolini <daiane.list@gmail.com> wrote:
> On Fri, Jan 9, 2015 at 3:39 PM, Daiane Angolini
> <daiane.angolini@freescale.com> wrote:
>> 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 <daiane.angolini@freescale.com>
>
> Please, see the rendered result here
> https://github.com/angolini/fsl-community-bsp-platform/blob/master/README.adoc
>
> Does it worth the change?
>
>
> Otavio, What do you think?
I like it :-)
> Would be a problem to have the README file renamed to README.adoc?
Sure not.
--
Otavio Salvador O.S. Systems
http://www.ossystems.com.br http://code.ossystems.com.br
Mobile: +55 (53) 9981-7854 Mobile: +1 (347) 903-9750
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [RFC][fsl-community-bsp-platform] README: Translate README to use Asciidoctor instead of markdown
2015-01-09 17:59 ` Daiane Angolini
2015-01-09 18:03 ` Eric Nelson
2015-01-09 18:30 ` Otavio Salvador
@ 2015-01-10 15:07 ` Trevor Woerner
2015-01-10 16:43 ` Otavio Salvador
2 siblings, 1 reply; 6+ messages in thread
From: Trevor Woerner @ 2015-01-10 15:07 UTC (permalink / raw)
To: Daiane Angolini; +Cc: meta-freescale@yoctoproject.org
On 01/09/15 12:59, Daiane Angolini wrote:
>> -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
>>
Is it safe to start recommending Dizzy?
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [RFC][fsl-community-bsp-platform] README: Translate README to use Asciidoctor instead of markdown
2015-01-10 15:07 ` Trevor Woerner
@ 2015-01-10 16:43 ` Otavio Salvador
0 siblings, 0 replies; 6+ messages in thread
From: Otavio Salvador @ 2015-01-10 16:43 UTC (permalink / raw)
To: Trevor Woerner; +Cc: meta-freescale@yoctoproject.org
On Sat, Jan 10, 2015 at 1:07 PM, Trevor Woerner <twoerner@gmail.com> wrote:
> On 01/09/15 12:59, Daiane Angolini wrote:
>>> -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
>>>
>
> Is it safe to start recommending Dizzy?
Sure! :)
--
Otavio Salvador O.S. Systems
http://www.ossystems.com.br http://code.ossystems.com.br
Mobile: +55 (53) 9981-7854 Mobile: +1 (347) 903-9750
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2015-01-10 16:43 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2015-01-09 17:39 [RFC][fsl-community-bsp-platform] README: Translate README to use Asciidoctor instead of markdown Daiane Angolini
2015-01-09 17:59 ` Daiane Angolini
2015-01-09 18:03 ` Eric Nelson
2015-01-09 18:30 ` Otavio Salvador
2015-01-10 15:07 ` Trevor Woerner
2015-01-10 16:43 ` Otavio Salvador
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.