December 06, 2021, 06:04:50 am

The Gang Garrison 2 Forum

Please login or register.

Login with username, password and session length
Advanced search  

News:

NOTICE: Due to a rise in bot activity, new posters need to be approved before posting.

Join the community Discord server!

Pages: [1]

Author Topic: Modern Readme using Markdown  (Read 2494 times)

PrOF

  • Full Member
  • ***
  • Karma: 43
  • Offline Offline
  • Posts: 597
  • Sometimes a dev. Only sometimes
Modern Readme using Markdown
« on: February 10, 2020, 06:43:57 am »

Intended to replace the .txt version, does any new player actually read it?


Here's the raw file, suggestions welcome: https://gist.github.com/PrOF-kk/6692b0ff5f6cfdbd4400a4cfdf18efee
Logged

ajf

  • (Ex-?)Developer and forum/web admin
  • *****
  • Karma: 7
  • Offline Offline
  • Posts: 3492
  • she's never quite as dead as you think
Re: Modern Readme using Markdown
« Reply #1 on: July 27, 2020, 12:36:42 pm »

The README is a text file so people can read it in the download with just notepad. Markdown is more a thing for developers I would say. If the Markdown still looks nice to read as text, I guess it could be used for releases but just renamed to txt?
Logged
aka Andrea.

did you know that spinning stars work like this???

I've seen things you people wouldn't believe. execute_strings on fire off the shoulder of Overmars. I watched object-beams glitter in the dark near the room_goto_fix. All those moments will be lost in time, like tears...in...rain. Time to die.

PrOF

  • Full Member
  • ***
  • Karma: 43
  • Offline Offline
  • Posts: 597
  • Sometimes a dev. Only sometimes
Re: Modern Readme using Markdown
« Reply #2 on: July 27, 2020, 05:17:13 pm »

I made this to modernise the GitHub page a bit, so we could keep both versions and use the Markdown one for Github and the .txt one for the release package.
The markdown version does not look nice at all when viewed in a text file.
A middle ground would be switching to .rtf but meh =/
Logged

PrOF

  • Full Member
  • ***
  • Karma: 43
  • Offline Offline
  • Posts: 597
  • Sometimes a dev. Only sometimes
Re: Modern Readme using Markdown
« Reply #3 on: October 01, 2020, 07:39:55 am »

I'd like to wrap this up for the October release. Here are the options (though I can't find the poll button):
  • Add a Markdown Readme, keep the current txt one as a separate file
  • Replace current txt Readme with the new Markdown one
  • Keep the current txt Readme, discard the new one
Logged

Phantom Brave

  • All Hail Classicwell
  • Moderator
  • *****
  • Karma: 70
  • Offline Offline
  • Posts: 12701
  • Another one --
Re: Modern Readme using Markdown
« Reply #4 on: October 01, 2020, 06:14:59 pm »

Readmes for downloadable games are definitely for being read by an end user with a normal a text editor.
Logged

http://steamcommunity.com/id/wareya/
ladies and gentlemen i would like to announce that the fact of the matter is up that the fact of the matter is a fact and it matters

PrOF

  • Full Member
  • ***
  • Karma: 43
  • Offline Offline
  • Posts: 597
  • Sometimes a dev. Only sometimes
Re: Modern Readme using Markdown
« Reply #5 on: October 02, 2020, 07:28:25 am »

This is the second version of the updated readme. I'll keep the .txt one and we'll still include it in the download.

  • Should I also add a link to the Discord server?
  • Let me know if you'd like some changes before I open up a second pull request.
(click to show/hide)
Logged

Intel Guard

  • GG2 Commentator
  • Retired Goja Warrior
  • ******
  • Karma: 44
  • Offline Offline
  • Posts: 8676
  • the s*x number
Re: Modern Readme using Markdown
« Reply #6 on: October 10, 2020, 03:41:06 am »

Yeah, add a link to the Discord
Logged
I've been listening to a bit of Green Day recently (past 2 months actually). Really raises the level of "fuckethesystem" in me.  :z5:
"god is dead."♫♫♫
Pages: [1]
 

Page created in 0.029 seconds with 37 queries.