Split readme and development files, autotag (!11) · Merge requests · NDIP / Project Templates / Python · GitLab

During the maintenance period on Monday, 14 Oct 2024, all new projects will no longer create a container registry as part of the project area. Already existing projects will be unaffected at this time. Instead, users should utilize the official ORNL container registries at camden.ornl.gov (internal/moderate) and savannah.ornl.gov (external/low). Please see ORNL Today article for more info.

Yakubov, Sergey requested to merge 12-split-readme-and-development-doc into main Oct 25, 2024

Summary of Changes

Current README file is actually not for users, for more for developers, which is wrong. So, I created a new file.

Also trying to autogenerate tags, so we don't have problems with `copier update`

Checklist

The MR has a clear and concise title
Code is self-documented and follows style guidelines.
Automated tests are written and pass successfully.
Regression tests (e.g. manually triggered system tests, manual GUI/tool tests, ...) are performed to make sure the MR does not break anything (when applicable)
Readme file is present and up-to-date.

Documentation Updates

Additional Notes

Closes #12 (closed)