search

Logic-Legends / Decision-Making-Frmwk

Decision-Making Framework
https://starter-kit-snzl.onrender.com/
ISC License
1 stars 4 forks source link

Update README for non-CYF User #57

Open andrewwhitehouse opened 1 year ago

andrewwhitehouse commented 1 year ago

Our project README should contain instructions so that Rana (or another ACE user) is able to run the code.

Assume some technical skill (able to use the command line and install packages) but not necessarily in-depth knowledge of the CYF stack.

README should include:

Note that the README content depends on https://github.com/Logic-Legends/Decision-Making-Frmwk/issues/51

andrewwhitehouse commented 1 year ago

I moved this back to Test in Progress after seeing it was closed and checking it. I see Internal Server Error when following the instructions. @leilafaez can we go through it tomorrow?

andrewwhitehouse commented 1 year ago

@leilafaez I created a PR with some TODO items here https://github.com/Logic-Legends/Decision-Making-Frmwk/pull/168

A Postgres script to create the database would be useful.

I use a Mac so the Postgres installation commands aren't relevant.

Perhaps say what the software pre-requisites are could be a compromise.

I'm around if you want to discuss.