draft 1 of README.md edits #8
Conversation
README.rst
Outdated
|
|
||
| To package and publish to PackageCloud | ||
| ====================================== | ||
| Run build.sh |
There was a problem hiding this comment.
nitpickey but put code in code blocks
README.rst
Outdated
| ====================== | ||
|
|
||
| Requirements: | ||
| - A Packagecloud.io key with Environment variable set to it, such as PACKAGE_CLOUD_KEY="PACKAGECLOUDKEY" |
There was a problem hiding this comment.
and that might as well be a link. i'd consider adding a link to our wiki as well but leaning against it as this fork could be made public.
README.rst
Outdated
| ====================== | ||
|
|
||
| Requirements: | ||
| - A Packagecloud.io key with Environment variable set to it, such as package_cloud_key="packagecloudkey" |
There was a problem hiding this comment.
err, i meant Packagecloud.io and Environment, the variable does need to be all caps
README.rst
Outdated
|
|
||
| Requirements: | ||
| - A Packagecloud.io key with Environment variable set to it, such as package_cloud_key="packagecloudkey" | ||
| - A clean branch |
There was a problem hiding this comment.
I don't think there's any real concept of a clean branch, what you mean to say here is a clean worktree.
|
Also I just realized that the README is actually |
|
(meaning that the link formatting etc needs to be corrected, see https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html#external-links) |
README.rst
Outdated
| This package offers a mock ``pyldap`` library that can be used | ||
| for testing code relying on ``pyldap`` without having to configure | ||
| This package offers a mock ``pyldap`` library that can be used | ||
| for testing code relying on ``pyldap`` without having to configure |
There was a problem hiding this comment.
one more annoying nitpick, no reason to wrap text here (i.e. 80 chars or w/e), so this should be one line.
@majuscule