Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Updates & Dependency Indicators #20

Open
shane-science opened this issue Jul 27, 2020 · 0 comments
Open

Documentation Updates & Dependency Indicators #20

shane-science opened this issue Jul 27, 2020 · 0 comments

Comments

@shane-science
Copy link

Working on gbFisher, it seems that all of the lda-soft software is apparently interlinked (e.g. gbFisher requires code files listed in other source directories of lda-soft)

Dependency issues aside (that architecture should be thought about carefully) I recommend updates to the documentation to include:

(1) instructions that clearly define the installation of lda-soft, which says you need to build the entire repository

(2) Instructions should also clearly indicate package dependencies (e.g. gsl, version, etc)

(3) In the individual documentations (e.g. for gbFisher) it should say at the top what you need to do to make the code. I tried to use the gbFisher makefile and it wigged out because it couldn't find the dependent file -- the point is you can't use the makefile as included in the src repository, so the documentation should be clear on that point

(3) I think it would be useful, if the architectural dependencies could be resolved, to only be able to use one part of lda-soft (e.g. gbFisher, without any intent of every using gbmcmc)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant