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.

Sign up for GitHub

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

Jump to bottom

docs: improve README #204

Merged
merged 8 commits into from
Nov 15, 2023
Merged

docs: improve README #204

merged 8 commits into from
Nov 15, 2023

Conversation

mattdl-radix
Copy link
Contributor

README update:

  • The pip install with double quotes avoids the following errors in zsh shell: zsh: 2.12.0 not found
  • Step 2 and 3 are rephrased a bit for clarity. Before, it could be interpreted as 'clone the poetry cookie-cutter project locally and run cruft create', instead of creating a new (and empty) repo.

@mattdl-radix mattdl-radix added the documentation Improvements or additions to documentation label Nov 10, 2023
@mattdl-radix mattdl-radix self-assigned this Nov 10, 2023
@mattdl-radix
Reducing ambiguity: making parent directory explicit, to make sure co…
138c56b 
…okiecutter is not run within the repository.
lsorber
lsorber reviewed Nov 13, 2023
View reviewed changes
Copy link
Member

@lsorber lsorber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the improvements @mattdl-radix!

Only some minor comments. If it's not too much trouble, could you also remove the spurious right parenthesis in the README's documentation of the docker_image template variable (in the table)?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
lsorber
lsorber reviewed Nov 15, 2023
View reviewed changes
Copy link
Member

@lsorber lsorber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some final details, and we're good to go from my side!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@mattdl-radix
Copy link
Contributor Author

Thanks for the final feedback! Feel free to merge

@lsorber lsorber merged commit 796002f into superlinear-ai:main Nov 15, 2023
2 checks passed
@lsorber lsorber changed the title README update docs: improve README Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lsorber lsorber lsorber left review comments

Assignees

@mattdl-radix mattdl-radix

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mattdl-radix @lsorber