https://github.com/datsfilipe/gen-readme

gen-readme wil generate a readme for you! you can even customize it by selecting which sections you want.
https://github.com/datsfilipe/gen-readme

aur cli generator hacktoberfest readme readme-generator rust

Last synced: 5 days ago
JSON representation

gen-readme wil generate a readme for you! you can even customize it by selecting which sections you want.

• Host: GitHub
• URL: https://github.com/datsfilipe/gen-readme
• Owner: datsfilipe
• License: mit
• Created: 2023-05-20T02:34:24.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-30T22:02:51.000Z (about 1 year ago)
• Last Synced: 2024-10-31T12:12:55.928Z (15 days ago)
• Topics: aur, cli, generator, hacktoberfest, readme, readme-generator, rust
• Language: Rust
• Homepage: https://crates.io/crates/gen-readme
• Size: 46.9 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# gen-readme

A readme generator. Well, trully? it just copies the template to your directory.

[![GitHub stars](https://img.shields.io/github/stars/datsfilipe/gen-readme.svg)](https://github.com/datsfilipe/gen-readme/stargazers)

![Repository Size](https://img.shields.io/github/repo-size/datsfilipe/gen-readme.svg)

![Language Count](https://img.shields.io/github/languages/count/datsfilipe/gen-readme.svg)

![Last Commit](https://img.shields.io/github/last-commit/datsfilipe/gen-readme.svg)

![Version](https://img.shields.io/badge/version-0.1.1-blue.svg)







![Meme](./assets/meme.jpg)






## Usage

Install the package globally:

- With `cargo`:

```bash

cargo install gen-readme

```

- With `AUR helper (yay)`:

```bash

yay -S gen-readme-bin

```

- With `AUR helper (paru)`:

```bash

paru -S gen-readme-bin

```

## How to Run the Project

1. Clone this repository: `git clone [email protected]:datsfilipe/gen-readme.git`.

2. Enter in the project directory: `cd gen-readme`.

3. Run the project: `cargo run`.

## How to Contribute

Follow these steps to contribute to the project:

1. Fork the repository.

2. Create a new branch: `git checkout -b feature-branch-name`.

3. Make your changes and commit them: `git commit -m 'Add some feature'`.

4. Push to the branch: `git push origin feature-branch-name`.

5. Open a pull request.

Please ensure that your code adheres to the project's coding standards.

## Contributors

    

        

            

                


                

                    Filipe Lima

                

            

        

    

## License

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