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

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

Open
SgtPooki opened this issue Feb 9, 2022 · 3 comments
Open

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

SgtPooki opened this issue Feb 9, 2022 · 3 comments
Assignees
@SgtPooki
Labels
help wanted Seeking public contribution on this issue kind/enhancement A net-new feature or improvement to an existing feature P1 High: Likely tackled by core team if no one steps up topic/docs Documentation

Comments

@SgtPooki
Copy link
Member

SgtPooki commented Feb 9, 2022

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 SgtPooki added kind/enhancement A net-new feature or improvement to an existing feature topic/docs Documentation labels Feb 9, 2022
@lidel lidel added help wanted Seeking public contribution on this issue P1 High: Likely tackled by core team if no one steps up labels Apr 8, 2022
@SgtPooki SgtPooki self-assigned this Apr 27, 2022
@SgtPooki
Copy link
Member Author

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

@achingbrain
Copy link
Member

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?

@SgtPooki
Copy link
Member Author

SgtPooki commented Jun 7, 2022

ok sounds good. will keep this on my list

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SgtPooki SgtPooki

Labels
help wanted Seeking public contribution on this issue kind/enhancement A net-new feature or improvement to an existing feature P1 High: Likely tackled by core team if no one steps up topic/docs Documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@lidel @achingbrain @SgtPooki