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

Add README.md to boilerplates #82

Closed
pitanyc opened this issue Jun 8, 2016 · 5 comments
Closed

Add README.md to boilerplates #82

pitanyc opened this issue Jun 8, 2016 · 5 comments
Labels

Comments

@pitanyc
Copy link

pitanyc commented Jun 8, 2016

Add a simple README.md file which would contain the basics:

  • Title
  • Reference how it was generated by MBP
  • Components: this is just a repeat of the things we checked on the website
    (ie: Node.js + express + ... )
  • License

Note this would greatly help when opening issues... so we don't have to enter one-by-one how we generated something but rather could just copy/paste from your generated README what we generated.

@sahat
Copy link
Owner

sahat commented Jun 8, 2016

Should be simple enough.

By the way, if you haven't seen the error modal dialog yet (I hope not), it's pretty neat. It comes with a Report a bug link that opens a new GitHub issue with the error message as Title and error stack trace as Body, making it pretty easy to track down the problems.

@sahat
Copy link
Owner

sahat commented Jun 8, 2016

@pitanyc Would having ISSUE_TEMPLATE.md (PR: #89) be enough or do you think there is some additional value in generating a README for each project?

@sahat sahat added the Easy label Jun 8, 2016
@pitanyc
Copy link
Author

pitanyc commented Jun 8, 2016

People will use the mega boiler plate to kick-start their projects (ala Hackaton Starter).
Then they git push remote to github or some other place.
And since they are lazy, having a README.md generated is definitely valued added in there.

Think abou hackatons or high school students who don't know what a README.md is or don't have time for it. It creates value to them and you can refer back to your github MBP project in it (free advertisement).

=)

@sahat
Copy link
Owner

sahat commented Jun 8, 2016

How does this look? Any improvement suggestions?


Mega Boilerplate App

Generated by http://megaboilerplate.com

Configuration

  • Platform: Node.js
  • Framework: Express
  • Template Engine: Jade
  • CSS Framework: Bootstrap
  • CSS Preprocessor: CSS
  • JavaScript Framework: React
  • Build Tool: Gulp
  • Unit Testing: Mocha
  • Database: SQL
  • Authentication: Facebook
  • Deployment: Heroku

License

The MIT License (MIT)

Copyright (c) 2016 Sahat Yalkabov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

@pitanyc
Copy link
Author

pitanyc commented Jun 8, 2016

Yeah looks good mate.

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

No branches or pull requests

2 participants