Update documentation - Githubissues

Bzomak / oolite-msys2

Builds oolite from scratch

0 stars 0 forks source link

Update documentation #60

Closed Bzomak closed 5 months ago

Bzomak commented 5 months ago

Update documentation

Pull Request Type

[ ] Bug Fix
[x] Documentation Update
[ ] Dependency Update
[ ] New Feature

Description

Updates the README and adds comments to all the scripts to document their expectations.

Checklist

[ ] Tests have been added or updated to cover the changes made in this pull request.
[x] Documentation has been updated to reflect the changes made in this pull request.
[x] Code follows the project's coding conventions and style guidelines.
[ ] All automated tests pass successfully.
[ ] Updates to the build process have been applied to both the GHA workflow and the from-fresh bash script.

Related Issues

Fixes #41, #54, and #15