README Formatting

[ElectronicsArchiver]

[ 
 Please Check The **Preview** 
 ][Preview]

• Update Description

  Plumy the Mindustry gradle plugin.

  
  

• Disable unused Widgets:

  • Releases

  
  

• Disable unused Tabs:

  • Projects

  • Wiki

  
  

• General formatting / spacing

• Added license badge

• Added quicklinks

• Moved usage / documentation hub into dedicated files

  Btw, the links to your GitHub Pages site for groovy & kotlin dsl are broken, well the pages are.

• Fixed license filename

• If you have any questions.

• In case you do not agree with some of the changes made in this PR, please first let me know about them, before disregarding it entirely so we can possibly find a middle ground and have it not go to waste.

 
            No, I'm not a robot.            
 

 
    Yes, you are not the first.    
 

 
     I just made a PR template.     
 

If you want to know more about Markdown check out:

                            

[liplum]

ありがとうございます！ It looks pretty nice and neat, but since mgpp is made for modding, I don't think this pull request is very suitable for programmers, aka. modders, at present.

First of all, I'm poor at visual design, so my words might be not convincing.

Readme

Readme is the first impression of a repo. The viewers, in this case, almost of them are modders, are seeking a gradle plugin to free themself from their busy work on building a mod and get a quick starting.

Icon is placed on the top.

Because preview.png is for GitHub repo preview, it's too large as a header. I will shrink it and create a dedicated image soon.

Badges

Website isn't a good name for the instruction that teach users how to use mgpp. It's a bit confusing that I even thought you had remade a new website for it, in other words, I didn't understand whether it was a descriptive user guide or a colorful showcase.

It could be instruction or Get Started.

That has hidden too much information behind a documentation badge. When a new viewer want to know mgpp, they have to jump around with the funny hyperlink, which I even didn't think the badges is a hyperlink at first sight because it's not a verb, such as Read Document or stands for a hyperlink.

Features Graph

I will resort them ordered by its importance for modding soon.

Documentation.md

Since I have made an instruction, it's redundant and obese to make other hyperlinks for only one purpose that tells viewers how to use this plugin. Then I will delete them.

Also, docs-shared/ folder is for sharing the same content in different pages in the instruction website with mkdocs.

Disable unused Widgets

Release isn't an unused widget, and I have the plan for another purpose.

Conclusion

The badges should be not only informative but simplified, such as User Guide, JavaDoc, Mod Template. There is no need to make a lot of hyperlinks jumping over the repo.

[liplum]

Disable unused Tabs is done.

[ElectronicsArchiver]

which I even didn't think the badges is a hyperlink at first sight because it's not a verb, such as Read Document or stands for a hyperlink.

It is absolutely common to have nouns for button names, just look at GitHub itself, the profile / front page has:

• Pull requests
• Issues
• Marketplace
• Overview
• Repositories
• Projects
• Packages
• Stars
• ...

I will resort them ordered by its importance for modding soon.

Sure~

Also, docs-shared/ folder is for sharing the same content in different pages in the instruction website with mkdocs.

I see, wasn't sure, what it was about.

Release isn't an unused widget, and I have the plan for another purpose.

Right now it is, but if you plan on using it sure.

The badges should be not only informative but simplified, such as User Guide, JavaDoc, Mod Template.

So you rather want those links as buttons on the README?

There is no need to make a lot of hyperlinks jumping over the repo.

3 is not what I consider a lot, but sure.

[ElectronicsArchiver]

@liplum better?

[liplum]

Thank for your contribution. I will make some small changes then.