search

kefranabg / readme-md-generator

📄 CLI that generates beautiful README.md files
https://www.npmjs.com/package/readme-md-generator
MIT License
10.94k stars 1.37k forks source link

Add run on repl.it badge to README #197

Closed runargs closed 4 years ago

runargs commented 4 years ago

I really like this! I think it would be an excellent tool for beginners to encourage good documentation practice and so I configured it to be able to run in-browser through repl.it. I'm sure there would be ways to make it run smoother but this seems to work to cover the basics of creating a README.md file. Capture You can read more about running repos on Repl.it here, or view the Repl here.

kefranabg commented 4 years ago

Hi @runargs,

Thanks for the PR.

I don't know Repl.it, could you provide more context and explain in details what .replit file consist in, and why it would improve readme-md-generator?

runargs commented 4 years ago

I'd just like to note that between when I last posted and now, the Repl.it appears to have stopped working as pictured above. I will try to fix that and do not recommend merging right now. But in the mean I'll answer your questions:

I don't know Repl.it, could you provide more context and explain in details what .replit file consist in, and why it would improve readme-md-generator?

Sure! Repl.it is an online IDE I've used in conjunction to others for a while now, and a recent feature they added allowed for import from GitHub. In general that means it's easier work with code no matter what computer you're on but imo, the most valuable part is that it lowers the barrier of entry to repositories for beginners.

I've found it makes CLI programs easy to run and explore in a sandboxed environment, in browser. I think the browser environment is much more familiar to beginners coming from sites like say CodeAcademy so Repl.it provides a nice transition piece between coding through those simplified learning resources and IDEs like say IntelliJ. Creating documentation like READMEs are a great practice to start early, so I thought it'd be a strong candidate to be able to run through the Repl.it IDE.

The .replit file is a TOML file that lets the service Repl.it understand what type of code the repository consists of and how to handle it. Similar to the files IntelliJ or VSCode or GitHub might add to a project. Let me know if you'd like any more detail!

kefranabg commented 4 years ago

Hi @runargs,

Sorry for the delay.

Unfortunately, I don't want to overcharge the repository with code or files if it's not used by a majority of users.

Thanks for taking time to submit this PR