Docs folder + updated docs

[originalfoo]

• Created new docs folder in repo root
• Moved following files in to it:
  • BUILDING_INSTRUCTIONS.md - updated content
  • PR_REVIEW_INSTRUCTIONS.md - updated content
  • ATTACHING_DEBUGGER.md - updated content
• Add logging instructions Document logging stuff #465
• Explain how to flick debug switches (in LOGGING.md)
• Refactor ATTACHING_DEBUGGER.md

Fixes #466
Fixes #465

[originalfoo]

@kvakvs How are debug switches turned on and off? Also, if someone wanted to add a new switch in future, is there anything they need to be aware of?

[kvakvs]

Somewhere around this section (actually it is located down at Line 54) you can mention that the solution expects to find TLM/dependencies directory with the game C# DLLs copied into it, or a link to <Steam>/Cities_Skylines/Cities_Data/Managed.

[originalfoo]

The reference path is mentioned but I didn't know about the TLM/depedencies folder, will add that in.

[kvakvs]

If you symlink it before trying the first build, it just finds everything and builds and never requires any references manipulation.

[originalfoo]

@kvakvs I've updated build docs to include note on the TLM\dependencies folder

[kvakvs]

@aubergine10 At this moment the only reliable way is to visit affected csproj'ects and add another define to the defines section. Per build configuration. Less global way which only covers 1 file is to add at the top of that file.

[originalfoo]

Not sure I understand the comment above. Is that for adding a complete new switch?

If I wanted to, for example, enable logging for parking AI, which already exists, how would that be achieved?

[kvakvs]

Oh do you mean the debug switches in the XML file? I never done that, and it probably could use some usability improvements.

[krzychu124]

You have to add (TLM/State/ConfigData/DebugSettings.cs):

• default value to Switches array,
• new DebugSwitch enum value,
• new boolean value in section of TMPE_GlobalConfig.xml file before running game

<Debug>
    <Switches> 
        <boolean>false</boolean>
         ...
    </Switches>
</Debug>

To turn off/on features just change correct value from false to true (index is the same as in DebugSettings Switches array) and run game.
That should work while in main game menu too but I didn't tested that (change value in xml, save file and then in mod options Maintenance -> Reload global configuration)

[originalfoo]

Urg, this is a nasty way to do the debug switch toggles in the xml file:

  <Debug>
    <Switches>
      <boolean>false</boolean>
      <boolean>false</boolean>
      <boolean>false</boolean>
      // ...
      <boolean>false</boolean>
    </Switches>
    <ExtVehicleType>None</ExtVehicleType>
    <ExtPathMode>None</ExtPathMode>
  </Debug>

Is there any way we could add some sort of human readable hint to those elements? Even if it was just an incrementing number eg. <boolean switch="1"> ...

[originalfoo]

This is ready for final review @krzychu124 @kvakvs

[kvakvs]

I don't know, looks fine
We should do something with naming the debug switches in XML, but i haven't used them and they don't create any pain for me, so kind of let it stay until we figure something out.

[originalfoo]

Yeah, they work reliably as is so I think leave them for now.

[krzychu124]

👍