README-maker-extention

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #llm #go #rust #nodejs #cli #kubernetes #security #pytorch #ios #openai

README-maker-extention

(★ 104)

It creates the README.md file for the alx projects

파일 탐색기

최종 버전 다운로드 (.zip)

- README-maker.png
- README-maker1.png
background.js
icon128.png
icon16.png
icon48.png
manifest.json
popup.html
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# README Maker Extension

A Chrome extension for generating README.md files for ALX projects.

![README Maker Extension](https://raw.githubusercontent.com/TutTrue/README-maker-extention/main/assets/README-maker.png)

![README Maker Extension](https://raw.githubusercontent.com/TutTrue/README-maker-extention/main/assets/README-maker1.png)

## Description
The README Maker Extension is a Chrome extension with a simple, intuitive interface that automates the creation of README.md files for ALX projects. It extracts relevant information from ALX project pages and generates a README.md file with the project name, learning objectives, and tasks with associated files. Users can then copy or download the generated README.md file.

## Features

- Extracts project name, learning objectives, and tasks with associated files from ALX project pages.
- Generates a formatted README.md file with the extracted information.
- Supports both mandatory and advanced tasks.
- Creates a table of tasks and associated files.
- Organizes learning objectives by categories.
- Copy or download generated README.md file

## Installation

1. Clone this repository: `git clone https://github.com/TutTrue/README-maker-extention.git`.
2. Open Google Chrome and navigate to `chrome://extensions`.
3. Enable "Developer mode" by toggling the switch at the top right corner.
4. Click on "Load unpacked" and select the cloned repository folder.

## Usage
#### youtube [video](https://www.youtube.com/watch?v=HEsgoJOjG5Y&ab_channel=nuuX) by [Mounssif](https://github.com/nuuxcode)

### OR

1. Open the ALX project page in Chrome at `https://intranet.alxswe.com/projects/`.
2. Click on the ALX README Maker extension icon in the toolbar to open extension popup window.
3. Click on Copy or Download button.
4. The extension will extract the necessary information from the page and generate a README.md file.

## License

This project is licensed under the [MIT License](LICENSE).

## Contributions

Contributions to this project are welcome. Feel free to open issues and submit pull requests.

## Authors

- Mahmoud Hamdy : 
<a href="https://github.com/TutTrue" target="blank"><img align="center" src="https://raw.githubusercontent.com/tandpfun/skill-icons/main/icons/Github-Dark.svg" alt="TutTrue" height="30" width="40" /></a>
<a href="https://www.linkedin.com/in/mahmoud-hamdy-8b6825245/" target="blank"><img align="center" src="https://raw.githubusercontent.com/tandpfun/skill-icons/main/icons/LinkedIn.svg" alt="mahmoud-hamdy-8b6825245" height="30" width="40" /></a>

- Emad Anwer : 
<a href="https://github.com/EmadAnwer/" target="blank"><img align="center" src="https://raw.githubusercontent.com/tandpfun/skill-icons/main/icons/Github-Dark.svg" alt="EmadAnwer" height="30" width="40" /></a>
<a href="https://www.linkedin.com/in/emadanwer/" target="blank"><img align="center" src="https://raw.githubusercontent.com/tandpfun/skill-icons/main/icons/LinkedIn.svg" alt="emadanwer" height="30" width="40" /></a>

README-maker-extention

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

README-maker-extention

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README