GitHub is one choice. The whole point is to have a code repository so you
can keep history and if let's say you lose your computer you save your code
on you have a place where you can get it. It also allows for you to allow
other people to join your development team in the future when you are a
millionaire and looking for help for your code base. It may never happen
but using git changes how you do things in only good ways. Github is not
your only choice though so look around if you don't like github. With that
said github has a command line client gh that makes tasks much easier that
works right beside git.
Ken
From: program-l-bounce@xxxxxxxxxxxxx <program-l-bounce@xxxxxxxxxxxxx> On
Behalf Of zachtidwell0331@xxxxxxxxx
Sent: Friday, April 29, 2022 8:27 AM
To: program-l@xxxxxxxxxxxxx
Subject: [program-l] Re: Creating and maintaining accessible documentation
for code bases
I haven't been, but I will start now. Are you mentioning GitHub, or a
command-line tool?
From: program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx>
<program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx> > On
Behalf Of kperry@xxxxxxxxxxxxx <mailto:kperry@xxxxxxxxxxxxx>
Sent: Thursday, April 28, 2022 8:27 AM
To: program-l@xxxxxxxxxxxxx <mailto:program-l@xxxxxxxxxxxxx>
Subject: [program-l] Re: Creating and maintaining accessible documentation
for code bases
Are you using a repo system like git. If not you should be. With that said
markdown is still a great way to keep documents.
From: program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx>
<program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx> > On
Behalf Of zachtidwell0331@xxxxxxxxx <mailto:zachtidwell0331@xxxxxxxxx>
Sent: Thursday, April 28, 2022 8:56 AM
To: program-l@xxxxxxxxxxxxx <mailto:program-l@xxxxxxxxxxxxx>
Subject: [program-l] Re: Creating and maintaining accessible documentation
for code bases
It will be private, just so that I can bring my front-end developer up to
speed with my back-end stuff, and to jog my memory in the future if I reuse
any of the systems I've created in future game projects.
From: program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx>
<program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx> > On
Behalf Of kperry@xxxxxxxxxxxxx <mailto:kperry@xxxxxxxxxxxxx>
Sent: Wednesday, April 27, 2022 6:26 PM
To: program-l@xxxxxxxxxxxxx <mailto:program-l@xxxxxxxxxxxxx>
Subject: [program-l] Re: Creating and maintaining accessible documentation
for code bases
Is this going to be open source or private. If private anything will do.
If open source a lot of times using things like markup works best because
when posting things like a markup file to a site like github it instantly
becomes a web page and is fully accessible.
Ken
From: program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx>
<program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx> > On
Behalf Of zachtidwell0331@xxxxxxxxx <mailto:zachtidwell0331@xxxxxxxxx>
Sent: Wednesday, April 27, 2022 6:32 PM
To: program-l@xxxxxxxxxxxxx <mailto:program-l@xxxxxxxxxxxxx>
Subject: [program-l] Creating and maintaining accessible documentation for
code bases
Hey all,
Following-up with my previous inquiry about C#, I've decided that it's time
I create documentation for my code, and that doing so while I'm rewriting my
existing code in C# would be a perfect time to do so.
With that, I'm still very new to programming, so I wanted to ask what you
all use for documenting your code?
