From 7b33ad62f7ba6bbf053e3817917562191763b972 Mon Sep 17 00:00:00 2001 From: surajphulara <68676996+surajphulara@users.noreply.github.com> Date: Thu, 1 Oct 2020 00:29:09 +0530 Subject: [PATCH] Updated and improved README.md corrected grammatical errors and improved the language --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1544c5d8b..587ba0492 100644 --- a/README.md +++ b/README.md @@ -3,28 +3,28 @@ Mono Project Website [![Build Status](https://travis-ci.org/mono/website.svg)](h This repository contains the files used for generating the [Mono website](http://www.mono-project.com). -The site uses [Jekyll](http://jekyllrb.com), a static site generator. GitHub Pages, where the site is hosted, natively supports Jekyll so every time someone pushes to this repository, the website will be built and updated. For hosting it yourself, see [Setting up a local copy of the website](#setting-up-a-local-copy-of-the-website). +The site uses [Jekyll](http://jekyllrb.com), a static site generator. The site is hosted on GitHub Pages which natively supports Jekyll so every time when someone pushes to this repository, the website will be built and updated. If you want to host it yourself then refer to : [Setting up a local copy of the website](#setting-up-a-local-copy-of-the-website). -Contributing to the website +### Contributing to the website --------------------------- -**Note:** Major issues or feature requests should be filed on the [issue tracker](https://github.com/mono/website/issues) first, so we can discuss the implications. +**Note:** The major issues or feature request should be filed on : [issue tracker](https://github.com/mono/website/issues) first, so that we can discuss the implications. -If you want to edit a page, the easiest way is to click the ![Edit page on GitHub](https://cloud.githubusercontent.com/assets/1376924/3712375/a6d7bc42-150f-11e4-9ceb-5230cbbfba3f.png) link under the page title on the website. +If you want to edit a page, the easiest way is to click the ![Edit page on GitHub](https://cloud.githubusercontent.com/assets/1376924/3712375/a6d7bc42-150f-11e4-9ceb-5230cbbfba3f.png) The link is available under the page title on the website. -This will open the source file on GitHub where you can click the pencil button to start editing: +This will open the source file on GitHub where you can click the pencil button to start editing the file: ![Arrow to pencil](https://cloud.githubusercontent.com/assets/1376924/3712474/1d2fe57a-1517-11e4-86b2-d083dbeaa4ae.png) -GitHub's editor shows you both the [Markdown](https://guides.github.com/features/mastering-markdown/) source as well as a preview of the rendered page: +GitHub's editor will show you both the [Markdown](https://guides.github.com/features/mastering-markdown/) source as well as a preview of the rendered page: ![Code editor](https://cloud.githubusercontent.com/assets/1376924/3769433/0f0ca2ee-18e1-11e4-97fc-3493683b853d.png) -After you've finished your changes, enter a proper summary and description and click the "Propose file change" button to open a pull request: +After you've finished making your changes, a prgiveoper summary and description and click the "Propose file change" button to open a pull request: ![Propose file change](https://cloud.githubusercontent.com/assets/1376924/3712481/52423448-1517-11e4-8aa8-9c9f9befb6bc.png) Setting up a local copy of the website -------------------------------------- -For larger changes, using the web-based editor on GitHub is not really convenient. A better way is to setup a local copy of the website where you can experiment. +For bigger changes, using the web-based editor on GitHub is not really convenient. A better way would be to setup a local copy of the website where you can experiment. ### Dependencies @@ -63,4 +63,4 @@ Writing a blog post Blogging is very easy with Jekyll. Browse to `_posts` directory, copy the Markdown file `_TEMPLATE.md` and rename that file following the file name convention: `YEAR-MONTH-DAY-title.md`. Then open the file you renamed and follow the steps there to complete writing a blog post. -Make sure to not include special characters in the file name. The blog entry's publishing date is automatically extracted from the file name. \ No newline at end of file +Make sure to not include special characters in the file name. The blog entry's publishing date is automatically extracted from the file name.