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 simple instructions for dependencies, build, and install #101

Open
bignose-debian opened this issue Aug 19, 2017 · 0 comments
Open

Add simple instructions for dependencies, build, and install #101

bignose-debian opened this issue Aug 19, 2017 · 0 comments

Comments

@bignose-debian
Copy link

There is no top-level document (e.g. the Read Me) stating how to satisfy dependencies, build, and install this code base.

There are CMake files, a Distutils script, a Vagrantfile, a Makefile. Which of those should the recipient use to satisfy build dependencies? What commands to run for building, for installing?

A simple text in the Read Me document (or, if they are more complex, maybe a separate INSTALL document) that says something like:

Get build dependencies:

    $ python3 -m pip install foo bar baz

Build this code base:

    $ cmake lorem/
    $ python3 -m setup build

Install the library:

    $ make install

would be enough to satisfy the recipient's need to know how to do those things.

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