search

NRL-Plasma-Physics-Division / block-on-spring

TurboPy app to compute the motion of a block on a spring
0 stars 5 forks source link

Create a README file #16

Closed arichar6 closed 3 years ago

arichar6 commented 4 years ago

This repo does not have a readme!

jeffugo commented 4 years ago

I'd love to work on this one.

arichar6 commented 4 years ago

I'd love to work on this one.

Awesome! Let me know if you have any questions about this.

jeffugo commented 4 years ago

@arichar6 thanks you! I understand that a readme introduces and explains a project. How do I get myself acquainted with this project?

arichar6 commented 4 years ago

The best way to get started with this project is to clone and run it. 1) Clone this repo 2) Create a new conda environment using the environment.yml file 3) Run the code using python run.py

arichar6 commented 3 years ago

@jeffugo How's the readme file going? I'm thinking about adding a minimal readme file, which could then be expanded. Would that help?

arichar6 commented 3 years ago

The readme was created in commit a9938f9435cc48e99d0eee7534db4ad66aa584dd