├── README-template-bliss.md ├── README-template-simplified.md ├── README-template.md ├── README.md └── images ├── preview-dark.png └── preview-light.png /README-template-bliss.md: -------------------------------------------------------------------------------- 1 | # ALX PROJECT NAME 2 | 3 | Description of the project...(remove this) 4 | 5 | - [Mandatory Task](#mandatory-task) 6 | - [Advanced Task](#advanced-task) 7 | - [Author](#author) 8 | - [Acknowledgments](#acknowledgements) 9 | - [Credits](#credits) 10 | - [Links](#link-to-template) 11 | 12 | ## Task Preview 13 | 14 | - [X] Mandatory Task 15 | - [X] task - 0 16 | - [ ] task - 1 17 | 18 | - [ ] Advanced Task 19 | - [ ] task - 101 20 | 21 | 22 | ## Mandatory Task 23 | 24 | #### [Task - 0](./file-name) 25 | 26 | **Challenge:** 27 | 28 | [Task 0](./file-name) 29 | 30 | ### [Task - 1](./filename) 31 | 32 | **Challenge:** 33 | 34 | [Task 1](./file-name) 35 | 36 | ## Advanced Task 37 | 38 | ### [Task - 013](./filename) 39 | 40 | **Challenge:** 41 | 42 | [Task 100](./file-name) 43 | 44 | ### [Task - 014](./filename) 45 | 46 | **Challenge:** 47 | 48 | [Task 101](./file-name) 49 | 50 | ## What I learned from this project 51 | 52 | Add what you learned here...(Remove this) 53 | 54 | ## Author 55 | 56 | - ALX - [ALX Africa](https://www.alxafrica.com) 57 | - Twitter - [_@yourusername_](https://twitter.com/yourusername) 58 | 59 | ## Acknowledgements 60 | 61 | Write your acknowledgements here...(Remove this) 62 | 63 | ## Credits 64 | 65 | This template is made possible and written by: 66 | 67 | **Author** 68 | - GitHub - [Kyilax](https://github.com/Kyilax) 69 | - Twitter - [@thexovc\_](https://www.twitter.com/thexovc) 70 | - Website - [Kyilax-Portfolio](https://kyilax-portfolio.vercel.app/) 71 | 72 | **Co-author:** 73 | - GitHub - [Evil-Ghost](https://github.com/Evil-Ghost) 74 | - Twitter - [@Evil\_Ghost\_\_](https://www.twitter.com/evil_ghost__) 75 | - Medium - [Evil Ghost](https://medium.com/@evilghost) 76 | - Website - [Coming soon...](#) 77 | 78 | Note: Do not remove this if you used this template 79 | 80 | ## Link to template 81 | 82 | - GitHub Repository - [alx-readme-template](https://github.com/Evil-Ghost/alx-readme-template) 83 | 84 | Note: Do not remove this if you used this template 85 | -------------------------------------------------------------------------------- /README-template-simplified.md: -------------------------------------------------------------------------------- 1 | # ALX README TEMPLATE SIIMPLIFIED(Replace this with title of the project) 2 | 3 | 21 | 22 | ## Overview 23 | 24 | ### Completed tasks 25 | 26 | - [x] task 0 27 | - [ ] task 1 28 | 29 | ### Links to task files 30 | 31 | - **Mandatory tasks** 32 | - [Task 0][Task 0] 33 | 34 | - **Advanced tasks** 35 | - [Task 8][Task 8] 36 | 37 | #### Links to other files 38 | - [Header file][Header file] 39 | 40 | 41 | [Task 0]: ./replace-this-with-file-name 42 | [Task 8]: ./replace-this-with-file-name 43 | [Header file]: ./replace-this-with-file-name 44 | 45 | ## Mandatory tasks 46 | 47 | ### Task 0 48 | 49 | 50 | ## Advanced tasks 51 | 52 | ### Task 8 53 | 54 | 55 | ## My process 56 | 57 | ### Built with 58 | 59 | 60 | ### What I learned 61 | 62 | 63 | ## Author 64 | 65 | - ALX - [ALX Africa](https://www.alxafrica.com) 66 | - Twitter - [_@yourusername_](https://twitter.com/yourusername) 67 | 68 | ## Acknowledgements 69 | 70 | 71 | ## Credits 72 | 73 | This template is made possible and written by: 74 | - GitHub - [Evil-Ghost](https://github.com/Evil-Ghost) 75 | - Twitter - [@Evil\_Ghost\_\_](https://www.twitter.com/evil_ghost__) 76 | - Medium - [Evil Ghost](https://medium.com/@evilghost) 77 | - Website - [Coming soon...](#) 78 | 79 | **Note: Do not remove this if you used this template** 80 | 81 | ## Link to template 82 | 83 | - GitHub Repository - [alx-readme-template](https://github.com/Evil-Ghost/alx-readme-template) 84 | 85 | **Note: Do not remove this if you used this template** 86 | -------------------------------------------------------------------------------- /README-template.md: -------------------------------------------------------------------------------- 1 | # ALX README TEMPLATE(Replace this with title of the project) 2 | 3 | Write what this project is all about. It can be a brief summary of what you are learning and what you will do 4 | **Note: Delete this note and the paragraph above after** 5 | **Important note: escape special characters like * and _ so that it doesn't affect the whole document. You will find examples where it was done if you go through the document. Delete this note after.** 6 | 7 | ## Table of contents 8 | 9 | - [Overview](#overview) 10 | - [Completed tasks](#completed-tasks) 11 | - [Links to task files](#links-to-task-files) 12 | - [Links to other files](#links-to-other-files) 13 | - [Mandatory tasks](#mandatory-tasks) 14 | - [Task 0](#task-0) 15 | - [Task 1](#task-1) 16 | - [Task 2](#task-2) 17 | - [Task 3](#task-3) 18 | - [Task 4](#task-4) 19 | - [Task 5](#task-5) 20 | - [Task 6](#task-6) 21 | - [Task 7](#task-7) 22 | - [Advanced tasks](#advanced-tasks) 23 | - [Task 8](#task-8) 24 | - [Task 9](#task-9) 25 | - [Task 10](#task-10) 26 | - [Task 11](#task-11) 27 | - [Task 12](#task-12) 28 | - [My process](#my-process) 29 | - [Built with](#built-with) 30 | - [What I learned](#what-i-learned) 31 | - [Author](#author) 32 | - [Acknowledgments](#acknowledgements) 33 | - [Credits](#credits) 34 | - [Link to template](#link-to-template) 35 | 36 | **Note: you can add or remove table of contents not needed or will be needed like tasks where you have more or less. Remember to add them to the content also with the link as done above. Delete this note after.** 37 | 38 | ## Overview 39 | 40 | ### Completed tasks 41 | 42 | - [x] task 0 43 | - [ ] task 1 44 | - [ ] task 2 45 | - [ ] task 3 46 | - [ ] task 4 47 | - [ ] task 5 48 | - [ ] task 6 49 | - [ ] task 7 50 | - [ ] task 8 51 | - [ ] task 9 52 | - [ ] task 10 53 | - [ ] task 11 54 | - [ ] task 12 55 | 56 | **Note: Replace space with x to mark to insert a tick which signifies you have completed the task. Delete this note after.** 57 | 58 | ### Links to task files 59 | 60 | - **Mandatory tasks** 61 | - [Task 0][Task 0] 62 | - [Task 1][Task 1] 63 | - [Task 2][Task 2] 64 | - [Task 3][Task 3] 65 | - [Task 4][Task 4] 66 | - [Task 5][Task 5] 67 | - [Task 6][Task 6] 68 | - [Task 7][Task 7] 69 | 70 | - **Advanced tasks** 71 | - [Task 8][Task 8] 72 | - [Task 9][Task 9] 73 | - [Task 10][Task 10] 74 | - [Task 11][Task 11] 75 | - [Task 12][Task 12] 76 | 77 | #### Links to other files 78 | - [Header file][Header file] 79 | 80 | **Note: The extra braces is to the links below. If you add a text at the top remember to put the link below. Follow the format which was used. Delete this note after.** 81 | 82 | [Task 0]: ./replace-this-with-file-name 83 | [Task 1]: ./replace-this-with-file-name 84 | [Task 2]: ./replace-this-with-file-name 85 | [Task 3]: ./replace-this-with-file-name 86 | [Task 4]: ./replace-this-with-file-name 87 | [Task 5]: ./replace-this-with-file-name 88 | [Task 6]: ./replace-this-with-file-name 89 | [Task 7]: ./replace-this-with-file-name 90 | [Task 8]: ./replace-this-with-file-name 91 | [Task 9]: ./replace-this-with-file-name 92 | [Task 10]: ./replace-this-with-file-name 93 | [Task 11]: ./replace-this-with-file-name 94 | [Task 12]: ./replace-this-with-file-name 95 | [Header file]: ./replace-this-with-file-name 96 | 97 | **Note: replace `replace-this-file-name` with the name of the task file eg `0-strcat.c`. You can also add links here and reference them using just the name in [brackts]. Delete this note after.** 98 | 99 | ## Mandatory tasks 100 | 101 | ### Task 0 102 | 103 | Write a function that concatenates two strings. 104 | - Prototype: char \*\_strcat(char \*dest, char \*src); 105 | - This function appends the... 106 | 107 | **Note: this is just an example you can write whatever you want here. Delete this note after.** 108 | 109 | **Task file:** [0-strcat.c][Task 0] 110 | 111 | **Note: the paragraph above is just an example. Replace `0-strcat.c` with your own filename if you want to use it. The second braces `[Task 0]` is taken from the links above. It's easier this way than writing the links all over again. Delete this note after.** 112 | 113 | ### Task 1 114 | 115 | 116 | ### Task 2 117 | 118 | 119 | ### Task 3 120 | 121 | 122 | ### Task 4 123 | 124 | 125 | ### Task 5 126 | 127 | 128 | ### Task 6 129 | 130 | 131 | ### Task 7 132 | 133 | 134 | ## Advanced tasks 135 | 136 | ### Task 8 137 | 138 | 139 | ### Task 9 140 | 141 | 142 | ### Task 10 143 | 144 | 145 | ### Task 11 146 | 147 | 148 | ### Task 12 149 | 150 | 151 | ## My process 152 | 153 | ### Built with 154 | 155 | - Shell 156 | - C 157 | - Python 158 | - Javascript 159 | 160 | **Note: remove and add whatever you used to build this project. Delete this note after** 161 | 162 | ### What I learned 163 | 164 | I learned about strings...(Replace this paragraph with yours) 165 | 166 | **Note: Write what you learned during this project. Delete this note after** 167 | 168 | ## Author 169 | 170 | - ALX - [ALX Africa](https://www.alxafrica.com) 171 | - Twitter - [_@yourusername_](https://twitter.com/yourusername) 172 | 173 | **Note: you are free to add more. Replace `yourusername` with yours. Delete this note after** 174 | 175 | ## Acknowledgements 176 | 177 | Thanks to Evil Ghost for helping me with this template...(Replace this paragraph with yours) 178 | - Twitter - [@Evil\_Ghost\_\_](https://www.twitter.com/evil_ghost__) 179 | 180 | **Note: Acknowledge the people who helped you during the project. You can include their names and also link to their social profiles. Remove or edit the Twitter link above. Delete this note after.** 181 | 182 | ## Credits 183 | 184 | This template is made possible and written by: 185 | - GitHub - [Evil-Ghost](https://github.com/Evil-Ghost) 186 | - Twitter - [@Evil\_Ghost\_\_](https://www.twitter.com/evil_ghost__) 187 | - Medium - [Evil Ghost](https://medium.com/@evilghost) 188 | - Website - [Coming soon...](#) 189 | 190 | **Note: Do not remove this if you used this template** 191 | 192 | ## Link to template 193 | 194 | - GitHub Repository - [alx-readme-template](https://github.com/Evil-Ghost/alx-readme-template) 195 | 196 | **Note: Do not remove this if you used this template** 197 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ALX README TEMPLATE 2 | 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 3 | 4 | It contains two versions: 5 | 1. [Regular](./README-template.md) 6 | 2. [Simplified](./README-template-simplified.md) 7 | 8 | Other styles: 9 | - [Bliss](./README-template-bliss.md) 10 | 11 | **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_ 12 | 13 | ## Table of Content 14 | 15 | - [Overview](#overview) 16 | - [Preview](#preview) 17 | - [Links](#links) 18 | - [Usage](#usage) 19 | - [Useful resource](#useful-resource) 20 | - [Author](#author) 21 | - [Acknowledgments](#acknowledgments) 22 | - [Contribute](#contribute) 23 | 24 | ## Overview 25 | 26 | ### Preview 27 | 28 | ![preview of README-template.md light](./images/preview-light.png) 29 | _Light background_ 30 | 31 | ![preview of README-template.md dark](./images/preview-dark.png) 32 | _Dark background_ 33 | 34 | 35 | ### Links 36 | 37 | - Link to this repository: [alx-readme-template](https://github.com/Evil-Ghost/alx-readme-template) 38 | 39 | ## Usage 40 | 41 | You can either clone, fork or download this repository to use it. 42 | The file needed is [**Regular**](./README-template.md). 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 43 | 44 | There is also a simplified version [**Simplified**](./README-template-simplified.md) 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 45 | 46 | If the you want other options there is also a variety of other template styles you can choose from which includes [Bliss](./README.template-bliss) and so on... 47 | ## Useful resource 48 | 49 | For those that don't have any idea how markdowns are written or you are having troubles editing the [**README-template.md**](./READMME-template.md) file, I put in a link to a tutorial below that you will find very useful 50 | 51 | - [Markdown Tutorial](https://www.markdowntutorial.com/) 52 | 53 | ## Author 54 | 55 | This template is made possible and written by: 56 | - GitHub - [Evil-Ghost](https://github.com/Evil-Ghost) 57 | - Twitter - [@Evil\_Ghost\_\_](https://www.twitter.com/evil_ghost__) 58 | - Medium - [Evil Ghost](https://medium.com/@evilghost) 59 | - Website - [Coming soon...](#) 60 | 61 | ## Acknowledgments 62 | 63 | All thanks to [Frontendmentor](frontendmentor.io) and [Markdown Tutorial](https://www.markdowntutorial.com/) for inspiring me to do this 64 | 65 | ## Contribute 66 | 67 | **Active Contributors:** 68 | - [kyilax](https://github.com/kyilax) 69 | 70 | If you want to contribute to this project you can send me a [mail](mailto:danielaisosajoseph@gmail.com) or a message on [Twitter](https://www.twitter.com/evil_ghost__) 71 | -------------------------------------------------------------------------------- /images/preview-dark.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Evil-Ghost/alx-readme-template/ce9ed3d3dc10f2619d2a66ea6e8724364ea57b56/images/preview-dark.png -------------------------------------------------------------------------------- /images/preview-light.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Evil-Ghost/alx-readme-template/ce9ed3d3dc10f2619d2a66ea6e8724364ea57b56/images/preview-light.png --------------------------------------------------------------------------------