Skip to content

This repo is to make a very beautiful reusable readme template in markdown.

Notifications You must be signed in to change notification settings

sejalbharti/Github_readme_template

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 

Repository files navigation

Objective

Creating a very informative and beautiful readme that explains in detail how to setup the project in our local machine along with this decoration!

Master Tool

This tool helps in making beautiful readme files quite easily. Use below tips and try using this editor here.

Example of good readme

These are some examples of some appealing and aesthetic yet informative readme's. Use them as reference.

1. Number One

2. Number two

Badges

Follow Github

Follow Twitter

GitHub forks

GitHub stars

GitHub watchers

Make your own here. Info about icons here.

I'm a social animal!

So connect with me and share your experience.

     

Mark Down CheatSheet

Can be found here.

Something unique

Kshitij Dhyani

Jumbotron for Readme

Images of the project goes here. drawing

Emoji's as text.

😀 😁 😂 😃 😄 😅 😆 😇 😈 😉 😊 😋 😌 😍 😎 😏 😐 😑 😒 😓 😔 😕.

More here.

Logos and icons.

drawing

More here.

Normal Template of a repo.

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

  • Dropwizard - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

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

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc

About

This repo is to make a very beautiful reusable readme template in markdown.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published