Skip to content

Commit

Permalink
README Update 📄
Browse files Browse the repository at this point in the history
  • Loading branch information
joaoofreitas committed Mar 27, 2021
1 parent 7c889d5 commit 0415bec
Showing 1 changed file with 58 additions and 19 deletions.
77 changes: 58 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
<!-- PROJECT LOGO -->
<br />
<p align="center">
<a href="https://github.com/joaoofreitas/challenge-generator">
<img src="" alt="Logo" width="80" height="80">
<img src="https://raw.githubusercontent.com/egonelbre/gophers/master/vector/superhero/standing.svg" alt="Logo" width="120" height="120">
</a>

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

<p align="center">
Expand All @@ -26,47 +25,87 @@
## Table of Contents

* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Download](#download)
* [Usage](#usage)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)
* [Acknowledgments](#acknowledgments)



## About The Project
## 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 fetches [this](https://raw.githubusercontent.com/karan/Projects/master/README.md) URL and parses it separating subjects, exercises, names, and descriptions into a structure that will be the gate for generating a file structure like this:

```bash
📦Project Learning
┣ 📂Classes
┃ ┣ 📂AirlineHotelReservationSystem
┃ ┃ ┗ 📜README.md
┃ ┣ 📂BankAccountManager
┃ ┃ ┗ 📜README.md
┃ ┣ 📂CompanyManager
┃ ┃ ┗ 📜README.md
┃ ┣ 📂FamilyTreeCreator
┃ ┃ ┗ 📜README.md
┃ ┣ 📂FlowerShopOrderingToGo
┃ ┃ ┗ 📜README.md
┃ ┣ 📂ImageGallery
┃ ┃ ┗ 📜README.md
┣ 📂ClassicAlgorithms
┃ ┣ 📂Closestpairproblem
┃ ┃ ┗ 📜README.md
┃ ┣ 📂CollatzConjecture
┃ ┃ ┗ 📜README.md
┃ ┣ 📂SieveofEratosthenes
┃ ┃ ┗ 📜README.md
┃ ┗ 📂Sorting
┃ ┃ ┗ 📜README.md
```

### 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 -->
## Download 📥

This program was meant to be compiled into a single executable. You can download it on my [_releases_](https://github.com/joaoofreitas/challenge-generator/releases) page and download the specific version for your platform.

## Usage 💻

For using this program, simply double-clicking would do the job, but if you want to see the logs properly you can run it in the terminal using:

``` bash
./path_to_executable_file
```

The base directory by default will have the name "Project Learning", but you can change before being generated by putting the name of the base directory as an argument:

``` bash
./path_to_executable_file <nameOfTheProjectBaseDir>
```

## 🚧 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**.
Contributions are what make the open-source community such an amazing place to 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'`)
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

Expand All @@ -77,9 +116,9 @@ Distributed under the MIT License. Check `LICENSE` for more information.

## 📫 Contact

João Freitas - <a href="mailto:[email protected]">Email</a>
João Freitas - <a href="mailto:[email protected]">_Contact me_</a>


## Acknowledgements
## Acknowledgments

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

0 comments on commit 0415bec

Please sign in to comment.