Release in: December 31, 2018

apsantos-dev · Dec 31, 2018 · 7a019c4 · 7a019c4
1 parent 66f972f
commit 7a019c4
Show file tree

Hide file tree

Showing 2 changed files with 148 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,44 +10,108 @@ Launches will have a separation bar for better viewing.
 
 ### Added
 
-> 1.0.1 (December 29, 2018)
+> v1.0.2 (December 31, 2018)
 
-- [CHANGELOG.md](CHANGELOG.md "Click here to open the file."): Description of the commit [system.sh](system.sh "Click here to open the file.") was missing.
-- [system.sh](system.sh "Click here to open the file."): .sh system for project management.
+- [CHANGELOG.md][_changelog]:
+  - Aliases to the links in this file. :102
+- [README.md][_readme]:
+  - Badges Section. :7
+  - Stable release version. :123
+  - Details on contributing to this project: :131
+  - License details. :139
+  - Alias for use in the links. :143
 
----
+> v1.0.1 (December 29, 2018)
+
+- [CHANGELOG.md][_changelog]:
+  - Description of the commit [system.sh][_system] was missing.
+- [system.sh][_system]:
+  - .sh system for project management.
 
-> 1.0.0 (December 29, 2018)
+---
 
-- _Created main project folder: [vscode-extensions/](/)_
-- [src/assets/doc/extensions.md](src/assets/doc/extensions.md "Click here to open the file."): These are extensions used in my day to day as a developer.
-- [.editorconfig](.editorconfig "Click here to open the file."): Sets the encoding styles for publishers. About [.editorconfig](https://editorconfig.org/ "Click to go to the project website.").
-- [.gitattributes](.gitattributes "Click here to open the file."): Provides attributes for path names. About [.gitattributes](https://git-scm.com/docs/gitattributes "Click to go to the project website.").
-- [.gitignore](.gitignore "Click here to open the file."): Specifies files that will not be monitored by Git. About [.gitignore](https://git-scm.com/docs/gitignore "Click to go to the project website.").
-- [CHANGELOG.md](CHANGELOG.md "Click here to open the file."): All changes will be documented in this file.
-- [CONTRIBUTING.md](CONTRIBUTING.md "Click here to open the file."): Explain how a participant should do things.
-- [LICENSE](LICENSE "Click here to open the file."): Sets the type of license the project will have. About [LICENSE](https://help.github.com/articles/licensing-a-repository/ "Click to go to the project website.").
-- [README.md](README.md "Click here to open the file."): Project details have been added. About [README.md](https://stackoverflow.com/questions/8655937/what-is-the-difference-between-readme-and-readme-md-in-github-projects "Click to go to the project website.").
-- [structure.md](structure.md "Click here to open the file."): Current structure of files and folders.
+> v1.0.0 (December 29, 2018)
+
+- Created main project folder:
+  - [vscode-extensions/][_path]
+- [src/assets/doc/extensions.md][_extensions]:
+  - These are extensions used in my day to day as a developer.
+- [.editorconfig][_editorconfig]:
+  - Sets the encoding styles for publishers. About [.editorconfig][_editorconfig-link].
+- [.gitattributes][_gitattributes]:
+  - Provides attributes for path names. About [.gitattributes][_gitattributes-link].
+- [.gitignore][_gitignore]:
+  - Specifies files that will not be monitored by Git. About [.gitignore][_gitignore-link].
+- [CHANGELOG.md][_changelog]:
+  - All changes will be documented in this file.
+- [CONTRIBUTING.md](CONTRIBUTING.md "Click here to open the file."):
+  - Explain how a participant should do things.
+- [LICENSE][_license]:
+  - Sets the type of license the project will have. About [LICENSE][_license-link].
+- [README.md][_readme]:
+  - Project details have been added. About [README.md][_readme-link].
+- [structure.md][_structure]:
+  - Current structure of files and folders.
 
 ### Changed
 
-> 1.0.1 (December 29, 2018)
+> v1.0.2 (December 31, 2018)
+
+- [CHANGELOG.md][_changelog]:
+  - The [vscode-extensions/][_path] link has been fixed.
+  - Structure of information pertaining to each file.
+  - Changed release description for use of Badges.
+- [README.md][_readme]:
+  - VSCode Version Title. :36
+  - Link with reference to VSCode installation on Linux. : 67
+  - Line break for better code viewing. :57, :87, :89, :91 :101
 
-- [CHANGELOG.md](CHANGELOG.md "Click here to open the file."): The [vscode-extensions/](/) link has been fixed.
-- [system.sh](system.sh "Click here to open the file."): Name some functions for better code reading.
+---
+
+> v1.0.1 (December 29, 2018)
+
+- [CHANGELOG.md][_changelog]:
+  - The [vscode-extensions/][_path] link has been fixed.
+- [system.sh][_system]:
+  - Name some functions for better code reading.
 
 ---
 
 ### Removed
 
-> 1.0.1 (December 29, 2018)
+> v1.0.1 (December 29, 2018)
 
-- [README.md](README.md "Click here to open the file."): Removed project version information
-- [system.sh](system.sh "Click here to open the file."): Removed project version information
+- [README.md][_readme]:
+  - Removed project version information
+- [system.sh][_system]:
+  - Removed project version information
 
 ### Updated
 
-> 1.0.1 (December 29, 2018)
-
-- [system.sh](system.sh "Click here to open the file."): Updated 'getopts' menu with more options
+> v1.0.2 (December 31, 2018)
+
+- [CHANGELOG.md][_changelog]:
+  - Updated links with reference to the files of this project.
+
+> v1.0.1 (December 29, 2018)
+
+- [system.sh][_system]:
+  - Updated 'getopts' menu with more options
+
+<!-- aliases -->
+[_path]: https://github.com/apsantos-dev/vscode-extensions
+[_extensions]: src/assets/doc/extensions.md "Click here to open the file."
+[_editorconfig]: .editorconfig "Click here to open the file."
+[_editorconfig-link]: https://editorconfig.org/ "Click to go to the project website."
+[_gitattributes]: .gitattributes "Click here to open the file."
+[_gitattributes-link]: https://git-scm.com/docs/gitattributes "Click to go to the project website."
+[_gitignore]: .gitignore "Click here to open the file."
+[_gitignore-link]: https://git-scm.com/docs/gitignore "Click to go to the project website."
+[_changelog]: CHANGELOG.md "Click here to open the file."
+[_contributing]: CONTRIBUTING.md "Click here to open the file."
+[_license]: LICENSE "Click here to open the file."
+[_license-link]: https://help.github.com/articles/licensing-a-repository/ "Click to go to the project website."
+[_readme]: README.md "Click here to open the file."
+[_readme-link]: https://stackoverflow.com/questions/8655937/what-is-the-difference-between-readme-and-readme-md-in-github-projects "Click to go to the project website."
+[_structure]: structure.md "Click here to open the file."
+[_system]: system.sh "Click here to open the file."
diff --git a/README.md b/README.md
@@ -2,17 +2,26 @@
 
 ## Introduction
 
-The main goal of this project is to share the [extensions](./src/assets/doc/extensions.md "Click here to open the file.") installed in VSCode for the development of web applications.
+The main goal of this project is to share the [extensions][extensions-ln] installed in VSCode for the development of web applications.
+
+<!-- Badges section here. -->
+[![License][license-img]][license-ln]
+[![CONTRIBUTING][contributing-img]][contributing-ln]
+[![GitHub stars][github-stars-img]][github-stars-ln]
+[![GitHub forks][github-forks-img]][github-forks-ln]
+[![Twitter Follow][twitter-follow-img]][twitter-follow-ln]
+
+---
 
 ### Before You Begin
 
-The development of this project was done in environment [Linux](https://en.wikipedia.org/wiki/Linux "Press Ctrl and click this link to open the page in a new tab."), using the Operating System [Fedora 29](https://getfedora.org/en/ "Press Ctrl and click this link to open the page in a new tab."). I used [Terminal](https://en.wikipedia.org/wiki/Linux_console "Press Ctrl and click this link to open the page in a new tab.") to run the [commands](https://en.wikipedia.org/wiki/Command_(computing) "Press Ctrl and click this link to open the page in a new tab.") described in this tutorial.
+The development of this project was done in environment [Linux][linux-ln], using the Operating System [Fedora 29][fedora-ln]. I used [Terminal][terminal-ln] to run the [commands][commands-ln] described in this tutorial.
 
 ```sh
 lsb_release -a  # to check system details
 ```
 
-When it is necessary to execute a command as [root](https://en.wikipedia.org/wiki/Sudo "Press Ctrl and click this link to open the page in a new tab."), I'll describe the content as follows. Example:
+When it is necessary to execute a command as [root][root-ln], I'll describe the content as follows. Example:
 
 ```sh
 sudo dnf install xyz  # command example
@@ -22,9 +31,9 @@ I recommend that you use the Operating System of your choice, adapting the proje
 
 > Additional | Editor:
 >
-> [VSCode](https://code.visualstudio.com/ "Press Ctrl and click this link to open the page in a new tab."): Visual Studio Code is a lightweight but powerful source code editor. \o/
+> [VSCode][vscode-ln]: Visual Studio Code is a lightweight but powerful source code editor. \o/
 
-### About Visual Studio Code
+### VSCode version on my machine
 
 > Version: 1.30.1 \
 Commit: dea8705087adb1b5e5ae1d9123278e178656186a \
@@ -41,11 +50,10 @@ OS: Linux x64 4.19.10-300.fc29.x86_64
 
 1 - To execute this project, I recommend that you have some tools installed on your machine. Are they:
 
-- [VSCode](https://code.visualstudio.com/docs/setup/linux#_rhel-fedora-and-centos-based-distributions "Press Ctrl and click this link to open the page in a new tab."): Visual Studio Code on Linux - RHEL, Fedora and CentOS based distributions
+- [VSCode][vscode-ln]: Visual Studio Code on Linux - RHEL, Fedora and CentOS based distributions
 
   ```sh
   sudo rpm --import https://packages.microsoft.com/keys/microsoft.asc
-
   sudo sh -c 'echo -e "[code]\nname=Visual Studio Code\nbaseurl=https://packages.microsoft.com/yumrepos/vscode\nenabled=1\ngpgcheck=1\ngpgkey=https://packages.microsoft.com/keys/microsoft.asc" > /etc/yum.repos.d/vscode.repo'
   ```
 
@@ -56,11 +64,11 @@ OS: Linux x64 4.19.10-300.fc29.x86_64
   sudo dnf install code
   ```
 
-  _For details on installing extension in VSCode, visit the following website: <https://code.visualstudio.com/docs/setup/linux#_rhel-fedora-and-centos-based-distributions>_
+  _For details on installing extension in VSCode, visit the following website: [VSCode Install][vscode-in]_
 
 ---
 
-- [Git](https://git-scm.com/ "Press Ctrl and click this link to open the page in a new tab."): Git is a free and open source distributed version control system.
+- [Git][git-ln]: Git is a free and open source distributed version control system.
 
   ```sh
   git --version  # to print Git version
@@ -76,17 +84,14 @@ OS: Linux x64 4.19.10-300.fc29.x86_64
 
 ```sh
 cd ~  # open folder for project creation
-
 git clone git@github.com:apsantos-dev/vscode-extensions.git <NAME-PROJECT>  # SSH
-
 or
-
 git clone https://github.com/apsantos-dev/vscode-extensions.git <NAME-PROJECT> # HTTPS
 ```
 
 3 - Attributes and permissions:
 
-Change the attributes and permissions of the file: [system.sh](./system.sh "Click to open the project.")
+Change the attributes and permissions of the file: [system.sh](system.sh "Click to open the project")
 
 > Be sure to check in which folder this project was cloned.
 
@@ -105,22 +110,58 @@ sh ~/<NAME-PROJECT>/system.sh
 
 ### The file
 
-[Click here](./src/assets/doc/extensions.md "Click here to open the file.") to open the file with the extensions used.
+[Click here][extensions-ln] to open the file with the extensions used.
 
 ### Structure
 
-See the file and folder [structure](./structure.md "Click and see the project!") for this project.
+See the file and folder [structure][structure-ln] for this project.
 
 ### Change Log
 
-All notable changes to this project will be documented in the file [CHANGELOG.md](./CHANGELOG.md "Click here to open the file.").
+All notable changes to this project will be documented in the file [CHANGELOG.md][changelog-ln].
 
-### Contributing
+_Stable release version:_
+
+[![Release][release-img]][release-ln]
 
-See details on contributing to this project at [CONTRIBUTING.md](./CONTRIBUTING.md "Click here to open the file.").
+### Contributing
 
 By contributing to this repository, please first discuss the change you wish to make via email or any other method with the owners of this repository before making a change.
 
+_See details on contributing to this project at:_
+
+[![CONTRIBUTING][contributing-img]][contributing-ln]
+
 ### License
 
-This project is licensed under "[The MIT License (MIT)](https://opensource.org/licenses/MIT "Click and see the project!")" - see the [LICENSE](./LICENSE) file for details.
+This project is licensed under "[The MIT License (MIT)][mit-ln]".
+
+_See license details at:_
+
+[![License][license-img]][license-ln]
+
+<!-- links -->
+[changelog-ln]: CHANGELOG.md "Click here to open the file"
+[commands-ln]: https://en.wikipedia.org/wiki/Command_(computing) "Press Ctrl and click this link to open the page in a new tab"
+[contributing-img]: https://img.shields.io/badge/vscode&ndash;extensions-CONTRIBUTE-orange.svg?style=flat-square
+[contributing-ln]: CONTRIBUTING.md "Contribute to make this boilerplate even better"
+[extensions-ln]: src/assets/doc/extensions.md "Click here to open the file"
+[fedora-ln]: https://getfedora.org/en/ "Press Ctrl and click this link to open the page in a new tab"
+[git-ln]: https://git-scm.com/ "Press Ctrl and click this link to open the page in a new tab"
+[github-stars-img]: https://img.shields.io/github/stars/apsantos-dev/vscode-extensions.svg?style=social&label=Star
+[github-stars-ln]: https://github.com/apsantos-dev/vscode-extensions/stargazers "See who likes this design = ]"
+[github-forks-img]: https://img.shields.io/github/forks/apsantos-dev/tests.svg?style=social&label=Fork
+[github-forks-ln]: https://github.com/apsantos-dev/vscode-extensions/fork "Click to view Star details of this project"
+[license-img]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
+[license-ln]: LICENSE "Copyright (c) 2018 APSantos Desenvolvimento de Sistemas"
+[linux-ln]: https://en.wikipedia.org/wiki/Linux "Press Ctrl and click this link to open the page in a new tab"
+[mit-ln]: https://opensource.org/licenses/MIT "Click and see the project"
+[release-img]: https://img.shields.io/github/release/apsantos-dev/vscode-extensions.svg?style=flat-square
+[release-ln]: https://github.com/apsantos-dev/vscode-extensions/releases "See all versions of this project"
+[root-ln]: https://en.wikipedia.org/wiki/Sudo "Press Ctrl and click this link to open the page in a new tab"
+[structure-ln]: structure.md "Click and see the project!"
+[terminal-ln]: https://en.wikipedia.org/wiki/Linux_console "Press Ctrl and click this link to open the page in a new tab"
+[twitter-follow-img]: https://img.shields.io/twitter/follow/apsantosdev.svg?label=Follow&style=social
+[twitter-follow-ln]: https://twitter.com/intent/follow?screen_name=apsantosdev "View my profile on Twitter"
+[vscode-ln]: https://code.visualstudio.com/ "Press Ctrl and click this link to open the page in a new tab"
+[vscode-in]: https://code.visualstudio.com/docs/setup/linux#_rhel-fedora-and-centos-based-distributions "Press Ctrl and click this link to open the page in a new tab"