ReadMyReadMe for Visual Studio Code

Description

A small linter for VSCode to establish a better best practice of the ReadMe files.

Table of Content

• Description
• Table of Content
• Installation
• Usage
• Contributing
• Contributors
• License

Installation

1. Open Visual Studio Code
2. Press Ctrl+P/⌘P to open the Quick Open dialog
3. Type ext install readmyreadme to find the extension
4. Click the Install button, then the Enable button

OR

1. Press Ctrl+Shift+X/⇧⌘X to open the Extensions tab
2. Type readmyreadme to find the extension
3. Click the Install button, then the Enable button

OR

1. Open a command-line prompt
2. Run code --install-extension fynnmenk.readmyreadme In VSCode Press F1 or CTRL+P (or CMD+P) and type out > ext install fynnmenk.readmyreadme. Check out the latest published version on the Visual Studio Marketplace.

Usage

When editing your README.md this linter is checking following features:

• outline structure of the README should match recommended outlines by the paper.
• TBA

Note: it is recommended to also consider following extension for a better Documentation Quality in your README file

• markdownlint
• Markdown All in One

Contributing

• Install Node.js
• Run npm install in this folder. This installs all necessary npm modules in both the client and server folder
• Open VS Code on this folder.
• Press Ctrl+Shift+B to start compiling the client and server in watch mode.
• Switch to the Run and Debug View in the Sidebar (Ctrl+Shift+D).
• Select Launch Client from the drop down (if it is not already).
• Press ▷ to run the launch config (F5).
• If you want to debug the server as well, use the launch configuration Attach to Server
• In the Extension Development Host instance of VSCode, open a document in 'plain text' language mode.
  • Open your README.md add uncommon headlines i.e. ## Uncommon to see features

Contributors

• contribute to be the first in this section :)

License

This is licensed under the MIT open source license. Do what you want with this software, just include notice that it orginated with me.