Skip to content
This repository has been archived by the owner on Feb 24, 2024. It is now read-only.

issue-35: readme generator #82

Merged
merged 5 commits into from
Dec 31, 2016
Merged

Conversation

briandowns
Copy link
Contributor

No description provided.

@markbates
Copy link
Member

Definitely a good start. Some info on how to run, or test, a Buffalo app would be great. Maybe a link to http://gobuffalo.io, that sort of thing.

@briandowns
Copy link
Contributor Author

Sounds good. Will add now.

@markbates
Copy link
Member

Here's the README that Rails generates:

https://raw.githubusercontent.com/rails/rails/master/railties/lib/rails/generators/rails/app/templates/README.md

It's a little "bland", but not a bad start.

I'm thinking things like:

  • link to buffalo docs
  • link to pop/soda docs
  • configuring the database.yml
  • running buffalo dev
  • running migrations
  • running tests

that sort of thing. doesn't have to be perfect, we can keep adding to it over time.

thanks for tackling this!

@briandowns
Copy link
Contributor Author

1.7 passed but NPM game up the ghost on master.

@briandowns
Copy link
Contributor Author

Ok, that's better.

@markbates markbates merged commit 1a9a214 into gobuffalo:master Dec 31, 2016
@markbates
Copy link
Member

Thanks. Brian!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants