Template for creating projects with Visual Studio Code
- Settings for Visual Studio Code
- README template with Emojis π€©
.gitattributes
for normalizing line endings tolf
π‘ Examples
These instructions will get you a release of this project up and running on your local machine, so that you can start using it.
- A GitHub Repository - Hosting for the software development version control Git
- Or just anything that can render Markdown will do
- You could even use this
README.md
directly as aREADME.txt
Just copy all files contained in this repository to wherever you need them.
π Documentation
These instructions will get you a copy of this project up and running on your local machine for development and testing purposes.
- Visual Studio Code - Code editor redefined and optimized for building and debugging modern web and cloud applications
- Get a copy of this repository
- Either by clicking the
Use this template
button next to theClone or download
button and creating a new GitHub repository based on this template - Or by clicking the
Clone or download
button and then cloning or just simply downloading the repository
- Either by clicking the
- Start editing the repository contents
- Either by opening up this
README.md
in your text editor - or, even better, open the whole folder into which you cloned or downloaded this repository - Or - if you're using a GitHub repository - by making the changes directly in the web interface, after you created your own repository based on this template
- Either by opening up this
- Rename the
LICENSE
file, so it's clear that is the license for this original repository and keep it in your repository- E.g. name it
LICENSE-template-vscode
- E.g. name it
- Add your own
LICENSE
file - Add your code and everything else, which is part of your project
- Add recommended extensions to
.vscode/extensions.json
underrecommendations
- You need to enter the extension's ID, which you can find by selecting the extension in VSCode's Extension menu and then you'll see it next to the extension's name in the main window
- Change the title (
#
) of this README according to your project name and choose a fitting emoji to add to it - Take a screenshot from your project in action and replace
docs/images/usage.png
with it - Edit the sections as you need
- Add documentation and examples to
docs/
, if needed- Otherwise remove
docs/docs.md
anddocs/examples.md
, as well as the relevant sections
- Otherwise remove
- Remove other sections you don't need
- Remove emojis from 3rd-level sections (
###
), if they are too close together (= not a lot of content in the sections) to avoid them getting too distracting
Do this thing to fix it.
- EmojiKeyboard - Get Emoji by Copy & Paste
- Library that was used - Short description of the library
- Robin Hartmann - robin-hartmann
- Entire Template
This project is licensed under the MIT License - see the LICENSE file for details.
- Special thanks to anyone you want to thank and similar things