Skip to content

πŸ“„ Template for creating projects with Visual Studio Code

License

Notifications You must be signed in to change notification settings

robin-hartmann/template-vscode

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“„ template-vscode

Template for creating projects with Visual Studio Code

⭐ Features

  • Settings for Visual Studio Code
  • README template with Emojis 🀩
  • .gitattributes for normalizing line endings to lf

πŸ’‘ Examples

⚑ Deployment

These instructions will get you a release of this project up and running on your local machine, so that you can start using it.

πŸ“‹ Prerequisites

  • 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 a README.txt

πŸš€ Getting Started

Just copy all files contained in this repository to wherever you need them.

πŸ“˜ Documentation

πŸ› οΈ Development

These instructions will get you a copy of this project up and running on your local machine for development and testing purposes.

πŸ“‹ Prerequisites

  • Visual Studio Code - Code editor redefined and optimized for building and debugging modern web and cloud applications

πŸš€ Getting Started

  1. Get a copy of this repository
    • Either by clicking the Use this template button next to the Clone 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
  2. 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
  3. 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
  4. Add your own LICENSE file
  5. Add your code and everything else, which is part of your project
  6. Add recommended extensions to .vscode/extensions.json under recommendations
    • 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
  7. Change the title (#) of this README according to your project name and choose a fitting emoji to add to it
  8. Take a screenshot from your project in action and replace docs/images/usage.png with it
  9. Edit the sections as you need
  10. Add documentation and examples to docs/, if needed
    • Otherwise remove docs/docs.md and docs/examples.md, as well as the relevant sections
  11. Remove other sections you don't need
  12. 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

🐞 Troubleshooting

Something is not working

Do this thing to fix it.

🧰 Built With

πŸ“š Resources

πŸ›οΈ Libraries

πŸ‘¨β€πŸ’» Authors

πŸ“ƒ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ‘ Acknowledgments

  • Special thanks to anyone you want to thank and similar things