Documentation: Add opti-fork implementation to-do list to Installation section of README

lucawrabetz / opti-face

A suite of tools for automating experiments in computational research.

MIT License

8 stars 1 forks source link

Documentation: Add opti-fork implementation to-do list to Installation section of README #1

Open lucawrabetz opened 5 months ago

lucawrabetz commented 5 months ago

Overview

This issue addresses the incomplete "Installation" section of our README.

Content Suggestions

Completion of this task includes discussion on the creation of a "TODO list" of tasks that an implementer / forker of opti-face must complete, before using the tools in the repository. Upon completion of this list of tasks after forking opti-face, a researcher should be guaranteed some set of functionality out of the box. This is the fundamental flow of opti-face forking.

lucawrabetz commented 5 months ago

Edit: Forking and installing packages to set up production python environment is now already in the installation subsection of README.md, so this issue specifically refers to the drafting of the implementation to-do list when an implementer forks opti-face, which will comprise the second half of the installation subsection.