Found 2,536 repositories(showing 30)
Naveduran
Automatic generator of readmes for git repositories (Includes file' listing)
JoelDeonDsouza
Nave is a ReadMe editor built using React. It allows users to select from a variety of templates, edit content, and view the rendered output in real-time.
dexpie
This is A Readme Generator
rahulapjs
Readme Creator is an AI-powered web application that helps developers generate professional, well-structured README files with live preview, customizable sections, and Gemini-based content optimization. Built with React, Redux, and Material-UI.
gdgc-ace
No description available
vshulman25
No description available
lorettarehm
README file creator that generates file using user answers provided by the user on the command-line prompts.
savabel
No description available
ArthurVBS
📃 Readme Generator
naturuplift
This is a tool that simplifies the process of creating well-structured README files for your software projects. With easy-to-follow prompts, it generates a markdown README template that you can customize to provide essential information about your project, making it more accessible to users and contributors. Save time and ensure clear documentation
VSLG2020
This node js project allows for clients to create their own custom ReadMe file that includes all the major information required for a proper ReadMe file.
Ghalbeyou
ReadMeGenerator is python application and with that you can create ReadMe.md files!
unknownsideofme
Chrome Extension for automatic Readme Generation
supercodingninja
Professional README Generator
lemanou7
## Your Task When creating an open source project on GitHub, it’s important to have a high-quality README for the app. This should include what the app is for, how to use the app, how to install it, how to report issues, and how to make contributions—this last part increases the likelihood that other developers will contribute to the success of the project. You can quickly and easily create a README file by using a command-line application to generate one. This allows the project creator to devote more time to working on the project. Your task is to create a command-line application that dynamically generates a professional README.md file from a user's input using the [Inquirer package](https://www.npmjs.com/package/inquirer). Review the [Good README Guide](../../01-HTML-Git-CSS/04-Important/Good-README-Guide/README.md) as a reminder of everything that a high-quality, professional README should contain. The application will be invoked by using the following command: ```bash node index.js ``` Because this application won’t be deployed, you’ll also need to provide a link to a walkthrough video that demonstrates its functionality. Revisit the Screencastify Tutorial in the prework as a refresher on how to record video from your computer. You’ll need to submit a link to the video _and_ add it to the README of your project. ## User Story ```md AS A developer I WANT a README generator SO THAT I can quickly create a professional README for a new project ``` ## Acceptance Criteria ```md GIVEN a command-line application that accepts user input WHEN I am prompted for information about my application repository THEN a high-quality, professional README.md is generated with the title of my project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions WHEN I enter my project title THEN this is displayed as the title of the README WHEN I enter a description, installation instructions, usage information, contribution guidelines, and test instructions THEN this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests WHEN I choose a license for my application from a list of options THEN a badge for that license is added near the top of the README and a notice is added to the section of the README entitled License that explains which license the application is covered under WHEN I enter my GitHub username THEN this is added to the section of the README entitled Questions, with a link to my GitHub profile WHEN I enter my email address THEN this is added to the section of the README entitled Questions, with instructions on how to reach me with additional questions WHEN I click on the links in the Table of Contents THEN I am taken to the corresponding section of the README ``` ## Getting Started Here are some guidelines to help you get started: * Create a `.gitignore` file and include `node_modules/` and `.DS_Store/` so that your `node_modules` directory isn't tracked or uploaded to GitHub. Be sure to create your `.gitignore` file before installing any npm dependencies. * Make sure that your repo includes a `package.json` with the required dependencies. You can create one by running `npm init` when you first set up the project, before installing any dependencies. * Include a video of the typical user flow through your application. This includes views of the prompts and the responses after their selection. * Include any other screenshots you deem necessary to help someone who has never been introduced to your application understand the purpose and function of it. This is how you will communicate to potential employers or other developers in the future what you built and why, and to show how it works.
CrispyCoder817
ReadMeGenerator
Dwalsh93
No description available
bethpresten
No description available
xtasherx
A step by step README generator to create a quality README for your project.
ZewoGraveyard
Tool to generate READEMEs for Zewo packages based on a template
Rconat
No description available
Jpeyton-hub
Utility to generate a nice-looking README file with node.js!
javivilchis
No description available
daze77
No description available
emilygoeres
No description available
mcclin53
No description available
tydangelo18
No description available
Blade7unner
The Node.js Professional README Generator utilizes Node.js and npm along with libraries like Inquirer.js and Markdown-it to simplify README file creation. It streamlines the process, enabling developers to swiftly generate polished project documentation with ease.
jeverett93
This is a command-line application that dynamically generates a README based on user input.
bnicholson87
No description available