rust-minigrep

A Rust application to find text in files. Similar to the grep command.
Explore the docs »

· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is a simple CLI app, part of the course: https://www.udemy.com/course/curso-completo-rust/

(back to top)

Built With

• [][https://www.rust-lang.org/]

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You need to have Cargo installed.

Installation

Just make sure to have Rust & Cargo installed.

(back to top)

Usage

This is a CLI application that needs two inputs: filepath and text to search.

For example, if you want to search for 'hello' in chat.txt, you would do:

	cargo run chat.txt hello

And the output will be all the results, line-separated.

(back to top)

Roadmap

• Make it beautiful, add colors
• Make it more verbose
• Add customization options

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Pol Milian - @polcodes - [email protected]

Project Link: https://github.com/el-pol/rust-minigrep

(back to top)

Acknowledgments

• Julio Andres

(back to top)