| Message ID | 1560183305-19989-1-git-send-email-pjtexier@koncepto.io |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [libubootenv] README: rework README file | expand |
Hi Pierre-Jean, On 10/06/19 18:15, 'Pierre-Jean Texier' via swupdate wrote: > - move extension from rst to md As github supports .rst files as README, I let .rst as format. Which is the advantage to switch to md ? Regards, Stefano > - add Travis-ci badge > > Signed-off-by: Pierre-Jean Texier <pjtexier@koncepto.io> > --- > README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ > README.rst | 60 ------------------------------------------------------------ > 2 files changed, 62 insertions(+), 60 deletions(-) > create mode 100644 README.md > delete mode 100644 README.rst > > diff --git a/README.md b/README.md > new file mode 100644 > index 0000000..cb689b7 > --- /dev/null > +++ b/README.md > @@ -0,0 +1,62 @@ > +libubootenv - Library to access U-Boot environment > +================================================== > + > +[](https://travis-ci.org/sbabic/libubootenv) > + > +libubootenv is a library that provides a hardware independent way to access > +to U-Boot environment. U-Boot has its default environment compiled board-dependently > +and this means that tools to access the environment are also board specific, too. > + > +Source Code: https://github.com/sbabic/libubootenv > + > +Documentation (doxygen): https://sbabic.github.io/libubootenv > + > +Replacement old tools > +--------------------- > + > +Part of the library are the replacement of the "fw_printenv / fw_setenv" tools that > +can be used with any board - they accept as parameter a file as initial environment if none is found > +on the persistent storage. The syntax for the file and for the data configuration file > +is the same as the one described in the U-Boot project. > + > +:: > + > + Usage fw_printenv [OPTION] > + -h, : print this help > + -c, --config <filename> : configuration file (old fw_env.config) > + -f, --defenv <filename> : default environment if no one found > + -V, : print version and exit > + -n, --no-header : do not print variable name > + > + Usage fw_setenv [OPTION] > + -h, : print this help > + -c, --config <filename> : configuration file (old fw_env.config) > + -f, --defenv <filename> : default environment if no one found > + -V, : print version and exit > + -s, --script <filename> : read variables to be set from a script > + > +License > +------- > + > +libubootenv is licensed under LGPL-2.1 > + > +OE / Yocto support > +------------------ > + > +Recipe is provided in meta-swupdate layer https://github.com/sbabic/meta-swupdate.git > + > +Buildroot support > +----------------- > + > +Package is provided in https://git.buildroot.net/buildroot/tree/package/libubootenv > + > +Contributing to the project > +--------------------------- > + > +Contributions are welcome ! You can submit your patches (or post questions > +regarding the project) to the swupdate Mailing List: > + > + swupdate@googlegroups.com > + > +Please read the [contributing](http://sbabic.github.io/swupdate/contributing.html) > +chapter in the documentation how to contribute to the project. > diff --git a/README.rst b/README.rst > deleted file mode 100644 > index cdd04e6..0000000 > --- a/README.rst > +++ /dev/null > @@ -1,60 +0,0 @@ > -libubootenv - Library to access U-Boot environment > -================================================== > - > -libubootenv is a library that provides a hardware independent way to access > -to U-Boot environment. U-Boot has its default environment compiled board-dependently > -and this means that tools to access the environment are also board specific, too. > - > -Source Code: https://github.com/sbabic/libubootenv > - > -Documentation (doxygen): https://sbabic.github.io/libubootenv > - > -Replacement old tools > ---------------------- > - > -Part of the library are the replacement of the "fw_printenv / fw_setenv" tools that > -can be used with any board - they accept as parameter a file as initial environment if none is found > -on the persistent storage. The syntax for the file and for the data configuration file > -is the same as the one described in the U-Boot project. > - > -:: > - > - Usage fw_printenv [OPTION] > - -h, : print this help > - -c, --config <filename> : configuration file (old fw_env.config) > - -f, --defenv <filename> : default environment if no one found > - -V, : print version and exit > - -n, --no-header : do not print variable name > - > - Usage fw_setenv [OPTION] > - -h, : print this help > - -c, --config <filename> : configuration file (old fw_env.config) > - -f, --defenv <filename> : default environment if no one found > - -V, : print version and exit > - -s, --script <filename> : read variables to be set from a script > - > -License > -------- > - > -libubootenv is licensed under LGPL-2.1 > - > -OE / Yocto support > ------------------- > - > -Recipe is provided in meta-swupdate layer https://github.com/sbabic/meta-swupdate.git > - > -Buildroot support > ------------------ > - > -Package is provided in https://git.buildroot.net/buildroot/tree/package/libubootenv > - > -Contributing to the project > ---------------------------- > - > -Contributions are welcome ! You can submit your patches (or post questions > -regarding the project) to the swupdate Mailing List: > - > - swupdate@googlegroups.com > - > -Please read the [contributing](http://sbabic.github.io/swupdate/contributing.html) > -chapter in the documentation how to contribute to the project. >
Hi Stefano, Le 10/06/2019 à 18:57, Stefano Babic a écrit : > As github supports .rst files as README, I let .rst as format. Which is > the advantage to switch to md ? Yes, it's right. But, in fact, it's mainly to be consistent with SWUpdate and keep the same syntax:) For example, today we have a display problem on Github with the "Contributing to the project" part. Because the file is markdown oriented, I think. Thanks, > > Regards, > Stefano
On 10/06/19 19:43, 'Pierre-Jean Texier' via swupdate wrote: > Hi Stefano, > > Le 10/06/2019 à 18:57, Stefano Babic a écrit : >> As github supports .rst files as README, I let .rst as format. Which is >> the advantage to switch to md ? > > Yes, it's right. > But, in fact, it's mainly to be consistent with SWUpdate and keep the > same syntax:) > > For example, today we have a display problem on Github with the > "Contributing to the project" part. Because the file is markdown > oriented, I think. > ok, I will apply this. Regards, Stefano > Thanks, > >> >> Regards, >> Stefano >
Le 10/06/2019 à 20:39, Stefano Babic a écrit : > ok, I will apply this. Thanks Stefano ! > > Regards, > Stefano
diff --git a/README.md b/README.md new file mode 100644 index 0000000..cb689b7 --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +libubootenv - Library to access U-Boot environment +================================================== + +[](https://travis-ci.org/sbabic/libubootenv) + +libubootenv is a library that provides a hardware independent way to access +to U-Boot environment. U-Boot has its default environment compiled board-dependently +and this means that tools to access the environment are also board specific, too. + +Source Code: https://github.com/sbabic/libubootenv + +Documentation (doxygen): https://sbabic.github.io/libubootenv + +Replacement old tools +--------------------- + +Part of the library are the replacement of the "fw_printenv / fw_setenv" tools that +can be used with any board - they accept as parameter a file as initial environment if none is found +on the persistent storage. The syntax for the file and for the data configuration file +is the same as the one described in the U-Boot project. + +:: + + Usage fw_printenv [OPTION] + -h, : print this help + -c, --config <filename> : configuration file (old fw_env.config) + -f, --defenv <filename> : default environment if no one found + -V, : print version and exit + -n, --no-header : do not print variable name + + Usage fw_setenv [OPTION] + -h, : print this help + -c, --config <filename> : configuration file (old fw_env.config) + -f, --defenv <filename> : default environment if no one found + -V, : print version and exit + -s, --script <filename> : read variables to be set from a script + +License +------- + +libubootenv is licensed under LGPL-2.1 + +OE / Yocto support +------------------ + +Recipe is provided in meta-swupdate layer https://github.com/sbabic/meta-swupdate.git + +Buildroot support +----------------- + +Package is provided in https://git.buildroot.net/buildroot/tree/package/libubootenv + +Contributing to the project +--------------------------- + +Contributions are welcome ! You can submit your patches (or post questions +regarding the project) to the swupdate Mailing List: + + swupdate@googlegroups.com + +Please read the [contributing](http://sbabic.github.io/swupdate/contributing.html) +chapter in the documentation how to contribute to the project. diff --git a/README.rst b/README.rst deleted file mode 100644 index cdd04e6..0000000 --- a/README.rst +++ /dev/null @@ -1,60 +0,0 @@ -libubootenv - Library to access U-Boot environment -================================================== - -libubootenv is a library that provides a hardware independent way to access -to U-Boot environment. U-Boot has its default environment compiled board-dependently -and this means that tools to access the environment are also board specific, too. - -Source Code: https://github.com/sbabic/libubootenv - -Documentation (doxygen): https://sbabic.github.io/libubootenv - -Replacement old tools ---------------------- - -Part of the library are the replacement of the "fw_printenv / fw_setenv" tools that -can be used with any board - they accept as parameter a file as initial environment if none is found -on the persistent storage. The syntax for the file and for the data configuration file -is the same as the one described in the U-Boot project. - -:: - - Usage fw_printenv [OPTION] - -h, : print this help - -c, --config <filename> : configuration file (old fw_env.config) - -f, --defenv <filename> : default environment if no one found - -V, : print version and exit - -n, --no-header : do not print variable name - - Usage fw_setenv [OPTION] - -h, : print this help - -c, --config <filename> : configuration file (old fw_env.config) - -f, --defenv <filename> : default environment if no one found - -V, : print version and exit - -s, --script <filename> : read variables to be set from a script - -License -------- - -libubootenv is licensed under LGPL-2.1 - -OE / Yocto support ------------------- - -Recipe is provided in meta-swupdate layer https://github.com/sbabic/meta-swupdate.git - -Buildroot support ------------------ - -Package is provided in https://git.buildroot.net/buildroot/tree/package/libubootenv - -Contributing to the project ---------------------------- - -Contributions are welcome ! You can submit your patches (or post questions -regarding the project) to the swupdate Mailing List: - - swupdate@googlegroups.com - -Please read the [contributing](http://sbabic.github.io/swupdate/contributing.html) -chapter in the documentation how to contribute to the project.
- move extension from rst to md - add Travis-ci badge Signed-off-by: Pierre-Jean Texier <pjtexier@koncepto.io> --- README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 60 ------------------------------------------------------------ 2 files changed, 62 insertions(+), 60 deletions(-) create mode 100644 README.md delete mode 100644 README.rst