aegir icon indicating copy to clipboard operation
aegir copied to clipboard

README doesn't have installation and/or getting started instructions

Open SgtPooki opened this issue 3 years ago • 3 comments

Is your feature request related to a problem? Please describe. I am starting a new project using aegir and noticed that there is no "getting started" or "installation" instructions.

Describe the solution you'd like Provide a small snippet of instructions that inform users how to kick off a new project using aegir.

Describe alternatives you've considered I figure I'm supposed to:

npm install -D aegir
mkdir -p src test ...

but...

  1. what is next?
  2. Is Item 1 above different for a typescript/esm/cjs/etc.. repo?
  3. What about for an existing repo?
  4. What tools does aegir replace?

Additional context N/A

SgtPooki avatar Feb 09 '22 17:02 SgtPooki

@hugomrdias @achingbrain would you two be open to me throwing a PR together to add a getting started section to the README?

SgtPooki avatar Apr 28 '22 09:04 SgtPooki

Please do, or if you want to create a 'bootstrap' command or standalone create-aegir-app tool or something that spits some default files out?

achingbrain avatar Apr 28 '22 15:04 achingbrain

ok sounds good. will keep this on my list

SgtPooki avatar Jun 07 '22 23:06 SgtPooki