You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
would be enough to satisfy the recipient's need to know how to do those things.
The text was updated successfully, but these errors were encountered: