diff --git a/README.md b/README.md index bf117c7..6b19beb 100644 --- a/README.md +++ b/README.md @@ -1 +1,85 @@ -# learn-me \ No newline at end of file + +
+

+ + Logo + + +

Challenge Generator

+ +

+ A program that generates a folder structure with challenges and projects for mastering a programming language. +
+ Explore the docs » +
+
+ Report Bug + · + Request Feature + · + Send a Pull Request +

+

+ + + +## Table of Contents + +* [About the Project](#about-the-project) + * [Built With](#built-with) +* [Getting Started](#getting-started) + * [Prerequisites](#prerequisites) + * [Installation](#installation) +* [Usage](#usage) +* [Contributing](#contributing) +* [License](#license) +* [Contact](#contact) +* [Acknowledgements](#acknowledgements) + + + +## About The Project + +This project was created just for fun since I wanted to follow [_Karan's_](https://github.com/karan) projects that are in [_this_](https://github.com/karan/Projects) repository. + +Before starting with the projects I realized that I'm too lazy to generate a whole file structure to separate and isolate the projects. So I decided to make a program to do it for me. + +This program fetches this URL: +[https://raw.githubusercontent.com/karan/Projects/master/README.md](https://raw.githubusercontent.com/karan/Projects/master/README.md) and parses it separating subjects from exercises, names and descriptions into a structure and the whole project structure. + + +### Built With + +This program is built purely with [Go](https://golang.org/). No need for extra libraries or any bloated stuff. Minimal and simple. + +I've chosen [Go](https://golang.org/) since it's one of the programming languages that I enjoy most. + + +## 🚧 Roadmap + +See the [open issues](https://github.com/joaoofreitas/challenge-generator/issues) for a list of proposed features (and known issues). + + +## 🤝 Contributing + +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **extremely appreciated**. + +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 + + +## 📝 License + +Distributed under the MIT License. Check `LICENSE` for more information. + +## 📫 Contact + +João Freitas - Email + + +## Acknowledgements + +Huge thanks to [Karan](https://github.com/karan) for creating the README. \ No newline at end of file