improve Farlands readme

D00Med / farlands

Steampunk/fantasy themed subgame with dinosaurs

29 stars 11 forks source link

improve Farlands readme #149

Open 22i opened 6 years ago

22i commented 6 years ago

screenshot_20171021_080536

readme.txt should be deleted and be replaced with 2 files:

license for code.txt - containing the license information
readme.md - contains basic information about Farlands

readme.md

pictures like header and main picture
Farlands subgame shorth description info
link to the forum thread
link to all the dev discussions
credit thanks to section

also we need to come up with farlands logo or header to put there and main picture to show Farlands charm

tobyplowy commented 6 years ago

@D00Med another one for you

tobyplowy commented 6 years ago

@D00Med is it possible to work on this today?

D00Med commented 6 years ago

@tobyplowy maybe, no promises. Like I said, I will be able to work on farlands again in two weeks. @22i Why should the readme be changed to this? There should already be a licence.txt file (and if not I will add it with this name), and I don't understand why the readme should be a different type of file? Most readme files I've seen have been .txt files, so I think that is better for consistency, and also because most people will be able to open them easily.

tobyplowy commented 6 years ago

Like I said, I will be able to work on farlands again in two weeks.

Wait you never said that did I miss something or am I just stupid? Also that's exiting news for how long will you be back?

D00Med commented 6 years ago

@tobyplowy I thought I mentioned it a couple of weeks ago? apologies if I didn't. But yeah, exams over after next week, then I have one week of holiday, and after that idk, I should have a lot more time.

22i commented 6 years ago

you could just rename readme.txt to license.txt and then add readme.md with all the suggestions in the first post.

@tobyplowy @D00Med good luck with the exams also lets make a test you two should both download aemp here https://github.com/22i/aemp extract it then try to open readme.md and report back what happens (if it opens what opens) and what operating system you are on.

the reason behind readme.md being md (markdown) instead of txt is to make repository more colorfull, interesting and to add pictures or gifs - makes people want to download Farlands more

you cant add pictures to txt files

everyone reads the github repository readme.md and if its a good one most will download

D00Med commented 6 years ago

@22i definitely not, the license file has what it needs, and the readme has what it needs. What I could do, is add another, fancier, readme file :)