Skip to content

A simple Readme generator made for my 42 development repositories using java.

License

Notifications You must be signed in to change notification settings

RochBlondiaux/42-Hellstar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


42 Hellstart

An awesome header generator coded in Java.

GitHub code size in bytes Number of lines of code Code language count GitHub top language GitHub last commit

Explore the docs »

Table of Contents

  1. ℹ️ About The Project
  2. 💻 Getting Started
  3. 🎯 Improvements
  4. 📷 Screenshots
  5. ✉️ Contact

ℹ️ About The Project

💬 Description

Actually, this project only because I'm one of the laziest person of this world...
My problem was that for every project of my 42 cursus I needed to copy my README.md file template and modify it manually.
As I said I'm really lazy, and I started thinking of creating this tool, after a week of hard thinking I finally choose to make it.
Now you know why this program exists, but you may ask me what it does?
It generates readme.md file based on a template, and I wanted to try javafx, so I decided to make a cool interface.

🔨 Built With

This project has been built with the followings libraries:

💻 Getting Started

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

📥 Installation

  1. Clone the repo
    git clone https://github.com/rochblondiaux/42-hellstar.git && cd 42-hellstar
  2. Build the project
    mvn clean package
    

❓ Usage

All you need to do is to launch the program by double-clicking it and fill all fields, it's that simple!
Don't forgot lazy people need simple solutions.

🎯 Improvements

Here is a list of things that can be greatly improved:

  • The UI (It was the first time I ever used JavaFxr)
  • The code (Actually, it's dirty and ugly)
  • Maybe implement some asynchronous file loading/saving

📷 Screenshots

Home page

First step page

Second step page

Third step page

✉️ Contact

Roch Blondiaux
🌎 www.roch-blondiaux.com
📧 [email protected]

About

A simple Readme generator made for my 42 development repositories using java.

Resources

License

Stars

Watchers

Forks

Packages