Skip to content

Step by Step Guide

Jump to bottom
Youssef Ismail (Joseph) edited this page Oct 27, 2022 · 3 revisions

Welcome to the Project-README-Template wiki!

Step-by-Step Guide

First and foremost thanks for reviewing my Project-README-Template! Remember your productive feedback can only make it better. Consider supporting this project with a star 💛

Intro

As we all have different preferences and tastes I thought to make my best effort to make this template customizable and concise as much as possible.

Steps

1-Setup,

2-Shields

After copying the file to your personal Repo, Add project shields by using Shields.io.

3-Logo

Add a Logo by simply inserting an image URL in the "src" attribute below.

Insert your github profile URL in the "href" attribute bellow.

<div align="center">
    <a href="https://github.com/YousefIbrahimismail" target="_blank">
        <img src="https://user-images.githubusercontent.com/59213365/197888886-4de4b57c-e537-4a1d-94a0-937a4d1a136a.png" 
        alt="Logo" width="290" height="290">
    </a>
</div>

4-Project Title

  • You can use an eye-catching dynamic typing-SvG
  • Instead, you can type your project name after a # header.

5-About

  • In this section, just add information about the project and try to keep it short and sweet.

6-How to use this project

  • Here you may add information about how and why to use this project.

7-Demo

  • You can add a demo here GH supports images/ GIFs/videos.
  • It's recommended to use GIFs as they are more dynamic
  • Review learning resources on how to create a demo.

8-Contents Table

  • This section is optional, yet having a contents table helps keep your README readable and more professional.

  • If you are not familiar with HTML, no worries we have all been there

  • Review learning resources on how to create anchor links.

9-Project Roadmap

  • Add this section in case the project has different phases Under production or will be updated.

  • Under production or will be updated.

  • Review learning resources on how to create a markdown checklist.

10-Documentation

  • You may add any documentation or Wikis in this section.

11-Contributors

12-Acknowledgments

  • Credit where it's due, feel free to share your inspiration sources, Stackoverflow questions, GitHub repos, tools, etc.

13-Feedback

  • You can add contacts information like your email and social media account
  • Also it's common to add some PR guidance.

14-Contact

  • Add contact methods like email, Twitter, etc.

15-License

  • Here you can add a project license for copyrights and distribution, check Choose License.

16-Extras

  • Use this HTML element to create a "back to top" button.
<p align="right"><a href="#project-readme-template---">back to top ⬆️</a></p>
github logo
Clone this wiki locally