search

Hexagon / pup

Universal process manager built in Deno
https://pup.56k.guru
MIT License
160 stars 5 forks source link

Documentation: Separate README.md for each example #1

Closed nhrones closed 1 year ago

nhrones commented 1 year ago

It's not clear how to run the example. How about a small readme.md in the example folder?

Hexagon commented 1 year ago

Thanks for the feedback! 👍

A README.md in each example folder would be great. With a short note on how to run (eather install globally before running pup in the example folder, or run deno run ../../pup.ts). Also, each readme could have a section describing the options used in the example and why.

This is a good entry for new contributors, will flag as help-wanted.

Hexagon commented 1 year ago

👍

Just a quick summary on what each example do and how to run it. Similar to the docker example. You can use that and the running instructions at https://github.com/Hexagon/pup#examples as a template