VT-AOE-DMAD-Drew-Bennett
commented
8 months ago Seth Taylor — Today at 2:21 PM Drew if you're creating a commit to add this to main can you fix the app/requirements.txt while you're there? Just removing the version number from dar-tool. I think the others should remain versioned for now and we can add something like dependabot to the repo in the future to help test that version changes to streamlit/pandas won't break anything
Overview
The current README lacks crucial instructions for users interested in installing DAR-T via pip and running the accompanying Streamlit application. Providing clear, step-by-step guidelines will improve user experience and encourage broader utilization of the project.
Proposed Enhancements
1. Installation Instructions for DAR-T
A detailed section under the README that outlines the steps required to install DAR-T using pip. This should include any prerequisites, the exact pip command, and any post-installation steps necessary to ensure DAR-T is correctly set up for use.
Suggested Section Title: Installing DAR-T via pip
Suggested Content:
pip install dar_tool2. Instructions for Running the Streamlit App
An additional section dedicated to guiding users through the process of setting up and running the Streamlit app. This includes information on any additional dependencies, environment setup, and the command to launch the app.
Suggested Section Title: Running the Streamlit Application
Suggested Content:
streamlit run app.py(assumingapp.pyis the entry point for the application)Expected Outcome
Incorporating these instructions into the README will not only make it easier for new users to get started with DAR-T and its Streamlit app but will also potentially increase the project's adoption and visibility.