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

Onboarding if no README present #299

Open
mxsdev opened this issue Jun 12, 2023 · 1 comment
Open

Onboarding if no README present #299

mxsdev opened this issue Jun 12, 2023 · 1 comment
Assignees

Comments

@mxsdev
Copy link
Contributor

mxsdev commented Jun 12, 2023

Currently, we just throw an error if a README file isn't present. This is a good opportunity to do some onboarding for making a new readme file.

Maybe also we can introduce a runme init command to auto-generate a runme-friendly README file?

@sourishkrout sourishkrout self-assigned this Jun 15, 2023
@christian-bromann
Copy link
Contributor

@sourishkrout I think we can close this, Runme now suggest cells to run based on other markdown files in the project:

❯ ls -la
total 8
drwxr-xr-x   3 christianbromann  wheel    96 Aug 11 15:00 .
drwxrwxrwt  34 root              wheel  1088 Aug 11 14:58 ..
-rw-r--r--   1 christianbromann  wheel    54 Aug 11 15:00 CONTRIBUTING.md
❯ runme
runme 1.6.0

> echo-hello (unnamed) CONTRIBUTING.md
    echo "Hello World!"


1/1  Choose ↑↓←→  Run [Enter]  Expand [Space]  Hide Unnamed [u]  Quit [q]

That said, there is a case where it throws an error when no markdown file is found in the project. Should we in this case suggest to create a README.md with some example content?

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

3 participants