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

Add documentation on SPARTAN dependencies #51

Open
harrisonCassar opened this issue Jan 18, 2021 · 0 comments
Open

Add documentation on SPARTAN dependencies #51

harrisonCassar opened this issue Jan 18, 2021 · 0 comments
Labels
documentation Documentation-related issues high priority Extra attention is needed
Milestone

Comments

@harrisonCassar
Copy link
Contributor

harrisonCassar commented Jan 18, 2021

When adding the master README in #32, I left many sections undone with TODOs. When trying to build SPARTAN on a new device, there's a few dependencies I needed to get the build running. Let's add some documentation on these to the master README (listing them, and giving a small description), as well as in a separate markdown document (describing a "tutorial" of steps for how to install each and every single dependency) placed in the docs subdirectory.

For now, we'll have this document cover a Windows 10 computer using Ubuntu and a MacOS system, as most development is being done on these two systems.

A few things I found when installing the dependencies myself on a Windows 10 computer using Ubuntu:

@harrisonCassar harrisonCassar added high priority Extra attention is needed documentation Documentation-related issues labels Jan 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation-related issues high priority Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant