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

Rehaul READMEs and add top-level README #27

Open
kbrandwijk opened this issue Dec 16, 2017 · 5 comments
Open

Rehaul READMEs and add top-level README #27

kbrandwijk opened this issue Dec 16, 2017 · 5 comments

Comments

@kbrandwijk
Copy link
Member

The readme is included in the boilerplate, so it also ends up in the generated project, which doesn't make much sense.

@marktani
Copy link
Contributor

Why not?
The different boilerplates are different enough, so that different README files are preferred.

@DevanB
Copy link
Member

DevanB commented Dec 16, 2017 via email

@kbrandwijk
Copy link
Member Author

Well, at the very least, they need to be completely overhauled.

  • It references a live demo
  • The node-basic once describe a project structure with index.ts, while it doesn't use typescript
  • The clone the repo steps are wrong
  • The getting started instructions is what you have already done to even get a local project with that readme
  • etc.

@marktani marktani changed the title Remove readme files from individual boilerplates and move to top level Rehaul READMEs and add top-level README Dec 16, 2017
@nikolasburk
Copy link
Contributor

nikolasburk commented Dec 21, 2017

We're tackling this right now, let's track the progress of the different repos and close it once all ore done:

@schickling
Copy link
Contributor

I remember @stubailo had a couple of thoughts on this. Would be great if we can get the ball rolling here ⚽️

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

5 participants