Re: [PATCH 1/1] Grammar and formatting improvements

[Nala Ginrut]

Hi Benson!
Thanks for the patch, here're some comments:

The GitLab repo should be updated to
https://gitlab.com/hardenedlinux/artanis

It seems most of the works are indentations, actually this won't affect
Markdown rederring, but IMO it's still good for maintaining.

Best regards.


Benson Muite writes:

> Limit to 80 characters per line.
>
> Signed-off-by: Benson Muite <benson_muite@emailplus.org>
> ---
>  README.md | 77 +++++++++++++++++++++++++++++++++++--------------------
>  1 file changed, 49 insertions(+), 28 deletions(-)
>
> diff --git a/README.md b/README.md
> index 5645323..8b17386 100644
> --- a/README.md
> +++ b/README.md
> @@ -3,41 +3,48 @@ GNU Artanis needs a logo, contribution is welcome!
>
>  NOTICE
>  =========
> -Since Jun 4th 2018, Microsoft has aquired GitHub, then GNU Artanis will 
> never try to organize community on GigHub, include issues and PR.
> -Please visit https://gitlab.com/NalaGinrut/artanis
> -
> -According to [GNU Ethical Repository Criteria 
> Evaluations](https://www.gnu.org/software/repo-criteria-evaluation.html). GNU 
> Artanis as GNU official project is not proper to be maintained on GitHub.
> -So I **will not** do maintenance work for GNU Artanis on github to show my 
> position on free software.
> -That means I **will not** response to issues or pull requests on GitHub. 
> Until GitHub show some respect to freedom of users on these issues:
> +Since Jun 4th 2018, Microsoft has aquired GitHub, then GNU Artanis will never
> +try to organize community on GitHub, include issues and PR. Please visit
> +https://gitlab.com/NalaGinrut/artanis
> +
> +According to
> +[GNU Ethical Repository Criteria 
> Evaluations](https://www.gnu.org/software/repo-criteria-evaluation.html).
> +GNU Artanis as GNU official project is not proper to be maintained on GitHub.
> +So I **will not** do maintenance work for GNU Artanis on GitHub to show my
> +position on free software.
> +That means I **will not** respond to issues or pull requests on GitHub, until
> +GitHub show some respect to freedom of users on these issues:
>  * No other nonfree software is required to use the site (thus, no Flash).
>  * Does not discriminate against classes of users, or against any country.
>
> -The maintenance repo will be these two:
> +The maintenance repos will be these two:
>  * [GNU official repo](http://git.savannah.gnu.org/cgit/artanis.git/)
>  Accepts patches and issues on mailing-list artanis@gnu.org
>
>  * [GitLab repo](https://gitlab.com/NalaGinrut/artanis)
>  Accepts issues and pull requests.
>
> -For historical reasons, GNU Artanis will maintain the site with gh-pages on 
> GitHub since the pages service on GitLab is very different so I can't just 
> move it simply.
> -Before we have a better/modern Savannah, we have to endure this situation.
> +For historical reasons, GNU Artanis will maintain the site with gh-pages on
> +GitHub since the pages service on GitLab is very different so I can't just 
> move
> +it simply. Before we have a better/modern Savannah, we have to endure this
> +situation.
>
>  GNU Artanis
>  =========
>
> -GNU Artanis aims to be a web application framework for Scheme.
> -The philosophy of Artanis is to be very radical, and to try
> -cutting-edge things.
> -So use it at your own risk...however, playing with it may result in
> -some cool experiences!
> +GNU Artanis aims to be a web application framework for Scheme. The 
> philosophy of
> +Artanis is to be very radical, and to try cutting-edge things. So use it at 
> your
> +own risk...however, playing with it may result in some cool experiences!
>
>  ## Features:
>
>  * GPLv3+ & LGPLv3+
>  * Very lightweight - easy to hack and learn for newbies.
>  * Support JSON/CSV/XML/SXML.
> -* A complete web-server implementation, including an error page handler.
> -* High concurrent async non-blocking server core based on delimited 
> continuations.
> +* A complete web-server implementation, including an error page
> +handler.
> +* High concurrent async non-blocking server core based on delimited
> +continuations.
>  * Has a Sinatra-like style route, hence the name "Artanis" ;-)
>  * Supported databases (through guile-dbi): MySQL/SQLite/PostgreSQL.
>  * Nice and easy web cache control.
> @@ -69,7 +76,9 @@ http://gnu.org/software/artanis/manual
>
>  The source to the manual is in the gh-pages branch.
>
> -Please **do not** modify the HTML pages directly. The pages are generated by 
> a certain static page generator, so please take a look at the concerned 
> directory -
> +Please **do not** modify the HTML pages directly. The pages are generated by 
> a
> +certain static page generator, so please take a look at the concerned
> +directory -
>
>  https://gitlab.com/NalaGinrut/artanis/tree/gh-pages
>
> @@ -77,7 +86,9 @@ https://gitlab.com/NalaGinrut/artanis/tree/gh-pages
>
>  The source to the manual is in the gh-pages branch.
>
> -Please **do not** modify the manual.texi and manual.html files directly, as 
> they are generated by org-mode. The file to be edited is 'manual.org' -
> +Please **do not** modify the manual.texi and manual.html files directly, as
> +they are generated by org-mode. The file to be edited is
> +'manual.org' -
>
>  https://gitlab.com/NalaGinrut/artanis/blob/gh-pages/docs/manual.org
>
> @@ -85,18 +96,28 @@ 
> https://gitlab.com/NalaGinrut/artanis/blob/gh-pages/docs/manual.org
>
>  Thank you very much for contributing!
>
> -In my opinion, bug reports are the most significant contributions. Please 
> don't hesitate to report in a proper way for me to reproduce.
> +In my opinion, bug reports are the most significant contributions. Please 
> don't
> +hesitate to report them in a reproducible manner.
>
> -Please read the manual carefully, and ask questions to know more about GNU 
> Artanis. The preferred way to discuss internals of Artanis is to send
> -mail to [artanis@gnu.org](https://lists.gnu.org/mailman/listinfo/artanis) 
> because it's good for archive. And you could discuss the bugs in issues for 
> better tracking than mails.
> +Please read the manual carefully, and ask questions to know more about GNU
> +Artanis. The preferred way to discuss internals of Artanis is to send mail to
> +[artanis@gnu.org](https://lists.gnu.org/mailman/listinfo/artanis)
> +because it's good for archive. And you could discuss the bugs in issues for
> +better tracking than mails.
>
> -I'll write articles about GNU Artanis occasionally on my blog: 
> http://nalaginrut.com
> +I'll write articles about GNU Artanis occasionally on my blog:
> +http://nalaginrut.com
>
> -GNU Artanis is aiming for product quality, since it's going to be used in a 
> real product. So we need the contributions in good quality.
> -The tiny or obvious fixes will be more likely to be applied. But bigger 
> contributions will be under strict review and discussion.
> +GNU Artanis is aiming for production quality, since it's going to be used in 
> a
> +real product. So we need high quality contributions.  Please send small or
> +obvious fixes, as these will be easy to apply.  For larger contributions, 
> please
> +discuss first as these will be more strictly reviewed.
>
> -Artwork and document writing is important contributions too and great 
> appreciated in GNU Artanis community. So does advocating on your blogs, wikis,
> -and webcasting tutorials. They're good ways to help GNU Artanis to form a 
> community.
> +Artwork and documentation are important contributions too and greatly
> +appreciated in the GNU Artanis community. So does advocating on your blogs,
> +wikis, and webcasting tutorials. They're good ways to help GNU Artanis form a
> +community.
>
> -If you're using GNU Artanis in your project, please share your experiences. 
> GNU Artanis wants to build a friendly community to help
> -people know more about free software and help functional programming to be 
> used in industry.
> +If you're using GNU Artanis in your project, please share your experiences. 
> GNU
> +Artanis wants to build a friendly community to help people know more about 
> free
> +software and help functional programming to be used in industry.


--
GNU Powered it
GPL Protected it
GOD Blessed it
HFG - NalaGinrut
Fingerprint F53B 4C56 95B5 E4D5 6093 4324 8469 6772 846A 0058

signature.asc
Description: PGP signature