Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qobulovasror/readme-generator
A CLI program that generates README files for projects
https://github.com/qobulovasror/readme-generator
cli node-js readme-generator
Last synced: 7 days ago
JSON representation
A CLI program that generates README files for projects
- Host: GitHub
- URL: https://github.com/qobulovasror/readme-generator
- Owner: qobulovasror
- License: mit
- Created: 2024-04-20T16:28:59.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-21T11:11:46.000Z (8 months ago)
- Last Synced: 2024-11-20T14:04:27.442Z (about 1 month ago)
- Topics: cli, node-js, readme-generator
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/mkrm
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Readme-Generator
A CLI program that generates README files for projects
Key Features •
Technologies Used •
Getting Started •
Contributing •
License •
Conclusion •
## About 📖
Command line (CLI) program that generates a readme file for your project. The readme file contains instructions for your project. The program is built using NodeJs. You install it globally on your computer and run it at the location of your project. It will then create a Readme file
## Key Features ✨
---
- There are ready-made templates for your project
- Choosing a template depending on the type of project
- Uses Emoji in instructions
- easy to use by short command
## Technologies Used 🤖
---
- **nodejs**
- **npm** or **yarn**
## Getting Started 👨🏻💻
---
You can run the program via npm or by downloading this repository
### Prerequisites
Before you begin, ensure you have met the following requirements:
- **nodejs**
- **npm** or **yarn**
### Installation and Configuration 🎯
Follow these steps to get the project up and running on your local machine:
1. **Clone the repository:**
```bash
git clone https://github.com/qobulovasror/readme-generator.git
```
2. Navigate to the project directory:
```bash
cd "readme-generator"
```
3. **Open code editor**
```bash
npm i -g .
```
### Installation using npm 🎯
1. **Install package:**
```bash
npm i -g mkrm
```
or
```bash
npm install -g mkrm
```
or
```bash
yarn global add mkrm
```
### Useing the program 🕹️
1. **You will go to the location of your project**:
```bash
cd yourProject
```
2. **Run app**
```bash
mkrm
```
## Contributing 🤝
---
We welcome contributions from the community to improve the project. To contribute, follow these steps:
1. **Fork the repository:**
Click the "Fork" button in the upper-right corner of the repository's page on GitHub. This will create a copy of the repository in your GitHub account.
2. **Clone the forked repository:**
```bash
git clone https://github.com/qobulovasror/readme-generator.git
```
3. **Create a new branch:**
```bash
git checkout -b feature/new-feature
```
Replace feature/new-feature with a descriptive branch name related to the feature or issue you're working on.
4. **Make your changes: **Implement your changes and ensure they follow the project's coding style and guidelines.
5. **Commit your changes:**
```bash
git commit -m "Add new feature or fix issue"
```
6. **Push your changes to GitHub:**
```bash
git push origin feature/new-feature
```
7. **Create a Pull Request**:Go to the GitHub page of your forked repository. Click on the **"Compare & pull request"** button next to your branch. Fill in the necessary details and submit the pull request.
8. **Review and address feedback**:Your pull request will be reviewed by the project maintainers. Address any feedback or comments provided during the review process.
9. **Merge your Pull Request:**Once your pull request has been approved and all checks pass, it will be merged into the main branch by a project maintainer.
Thank you for your contribution!
## License 🧾
This project is licensed under the [MIT License](LICENSE)
You are free to:
- Use the code for personal or commercial purposes.
- Modify, distribute, and sublicense the code.
Under the following conditions:
- You must include the original copyright notice in all copies or substantial portions of the software.
This project is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software
## Conclusion 🔚
Congratulations! You've reached the end of the README file for our project 😊. We hope this documentation has provided you with all the necessary information to understand, install, and contribute to the project effectively.
If you have any questions, feedback, or suggestions, please don't hesitate to reach out to us. Your input is valuable and helps us improve the project for everyone.
Thank you for your interest and support in our project. Happy coding! 🎉