Skip to content

Commit

Permalink
README Update before release 🧾
Browse files Browse the repository at this point in the history
  • Loading branch information
joaoofreitas committed Mar 27, 2021
1 parent 0665490 commit 7c889d5
Showing 1 changed file with 85 additions and 1 deletion.
86 changes: 85 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,85 @@
# learn-me
<!-- PROJECT LOGO -->
<br />
<p align="center">
<a href="https://github.com/joaoofreitas/challenge-generator">
<img src="" alt="Logo" width="80" height="80">
</a>

<h3 align="center">Challenge Generator</h3>

<p align="center">
A program that generates a folder structure with challenges and projects for mastering a programming language.
<br />
<a href="https://github.com/joaoofreitas/challenge-generator/"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/joaoofreitas/challenge-generator/issues">Report Bug</a>
·
<a href="https://github.com/joaoofreitas/challenge-generator/issues">Request Feature</a>
·
<a href="https://github.com/joaoofreitas/challenge-generator/pulls">Send a Pull Request</a>
</p>
</p>



## 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 -->
## 🚧 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 - <a href="mailto:[email protected]">Email</a>


## Acknowledgements

Huge thanks to [Karan](https://github.com/karan) for creating the README.

0 comments on commit 7c889d5

Please sign in to comment.