docs: update README with comprehensive install steps#74
docs: update README with comprehensive install steps#74liammulh wants to merge 2 commits intonumberscope:mainfrom liammulh:issue_73
README with comprehensive install steps#74Conversation
| message) then your distribution is lacking these header files. You likely | ||
| will need to install the "Python development" package for your operating | ||
| system (the details of doing so are beyond the scope of these instructions). | ||
| message) then your distribution is lacking these header files. |
There was a problem hiding this comment.
Just to make sure I understand; this phrasing has been removed because it went from "beyond the scope" to being included below, right?
| public | user | table | <username for psql> | ||
| public | user_id_seq | sequence | <username for psql> | ||
| db=# \q | ||
| ``` |
There was a problem hiding this comment.
is the above commands or output or both?
|
My two cents: The install instructions have now become too long/detailed/low-level for a README. My recommendation is to provide a high-level setup overview in the README (similar to what was there before, but even more of an outline) and move the detailed instructions from this into something like |
This PR does the following: - adds a code formatter (Black) - adds a linter (ruff) - adds tests (Pytest) - documents code by adding Python docstring comments to functions and methods - attempts to address #69 - attempts to address some of the feedback in #74 There are some minor changes that aren't worth delving into in the commit message. The API has changed somewhat, so if we were using Semantic Versioning, this would be a breaking change / major version upgrade. I will go into more detail in the pull request description on GitHub.
|
#76 supersedes this PR. |
3 participants
Closes #73.
We now know the exact steps to get a working instance of backscope on a fresh Ubuntu, so I have updated the
READMEwith those steps.