Skip to content

Evil-Ghost/alx-readme-template

Repository files navigation

ALX README TEMPLATE

This is a ready made template which can be used for your README.md task in ALX. All you need to do is some minor editing and don't forget to remove the notes and paragraph where stated

It contains two versions:

  1. Regular
  2. Simplified

Other styles:

Read Me: Don't forget to give this repository a star if you find it useful and also come back to check more for updates

Table of Content

Overview

Preview

preview of README-template.md light
Light background

preview of README-template.md dark
Dark background

Links

Usage

You can either clone, fork or download this repository to use it.
The file needed is Regular. You need to copy this file to your project that you are working on, edit it to your taste but don't remove the Credits and Link to template tags, then rename it to README.md

There is also a simplified version Simplified for those who already get the hang of everything and writing markdown files. You also don't have to delete the notes because they have already been removed. Use the simplified version only if you already know your way around writing mardown files efficiently

If the you want other options there is also a variety of other template styles you can choose from which includes Bliss and so on...

Useful resource

For those that don't have any idea how markdowns are written or you are having troubles editing the README-template.md file, I put in a link to a tutorial below that you will find very useful

Author

This template is made possible and written by:

Acknowledgments

All thanks to Frontendmentor and Markdown Tutorial for inspiring me to do this

Contribute

Active Contributors:

If you want to contribute to this project you can send me a mail or a message on Twitter

About

A readme.md template which can be used with alx task

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published