After chatting with @lukehare, it is apparent that the repo structure is confusing. Below are some notes for cleaning up the repo and ways of working. It is worth spending time on this now because it will only get more cluttered as we go.
Ways of working: start using issue tracking more readily, have a develop branch and branch naming fix/XX, feature/XX where <XX> is issue number.
Delete unused/commented code. There are also a bunch of development scripts and it is unclear what is necessary and what is development.
Update head README in line with Tim's installation notes.
There are at least two setup_fs.py files.
redundant .gitignore and .gitmodules files
we have two host directory. Consider renaming for clarity.
in a few places you need to copy and paste simcard related stuff like ADM1 keys. Have a file where you can keep these (and add them to .gitignore) and have the codebase pick them up automatically.
should sim-tools be a forked repo then added submodule, rather than a folder?
can we have script (e.g. makefile) that automates much of the installation?
After chatting with @lukehare, it is apparent that the repo structure is confusing. Below are some notes for cleaning up the repo and ways of working. It is worth spending time on this now because it will only get more cluttered as we go.
develop
branch and branch namingfix/XX
,feature/XX
where <XX
> is issue number.setup_fs.py
files..gitignore
and.gitmodules
fileshost
directory. Consider renaming for clarity.ADM1
keys. Have a file where you can keep these (and add them to .gitignore) and have the codebase pick them up automatically.sim-tools
be a forked repo then added submodule, rather than a folder?Please add to this list.