UQ-PAC / BASIL

Apache License 2.0
8 stars 0 forks source link

New developer onboarding documentation #214

Closed ailrst closed 4 months ago

ailrst commented 4 months ago

This merges the wiki and readme into some markdown files in the respository so that we have

  1. A place to explain software design decisions
  2. Documentation for new developers to get started on the project

The goal is that keeping this in the repository is that its version history is tied to the code version history, so we have reason to keep it updated. Most of it should be abstract enough not to require constant updating though.

The long explanation in the readme is split up into sections in the documentation now.