Update Andromeda description and add centralized dev instructions #80
Conversation
Co-authored-by: John Bradley <[email protected]>
…r Andromeda papers and source repos.
egrace479
force-pushed
the
docs/description
branch
from
10399f3 to
5aca5c7
Compare
|
Added a |
…meda. Co-authored-by: John Bradley <[email protected]>
egrace479
force-pushed
the
docs/description
branch
from
575d9c3 to
692a1ec
Compare
Co-authored-by: Hilmar Lapp <[email protected]>
…23 work. This is following response from lab PI (Chris North) on appropriate licensing for andromeda source materials.
…ocs/description
Co-authored-by: House <[email protected]>
| 2. Frontend nodejs/react development server | ||
|
|
||
| For instructions on buliding and running the Docker container see [Developing with Docker](https://github.com/Imageomics/Andromeda/wiki/Developing-with-Docker). | ||
| 1. Python Flask Backend API Server: navigate to the `andromeda` folder and run |
There was a problem hiding this comment.
I'm wondering whether we shouldn't simply defer to the subsequently mentioned subfolder README for all executable instructions, to prevent these from accidentally diverging in the future (and to prevent unintended mistakes, such as implicitly disabling CORS when that wasn't expected).
There was a problem hiding this comment.
I added this into the main README, since otherwise you have to go to two separate subfolder READMEs to get instructions for running locally, which can complicate what is otherwise a simple process.
Added a more full description of Andromeda (the package in the repo and the tool itself). Also added the directions to run Andromeda locally to the main repo README so they're not split between two README's in separate folders.