From 8479e46f1e3d102b8aa4d222b04f5c0c00845f00 Mon Sep 17 00:00:00 2001 From: Michael Cole Date: Mon, 14 Apr 2014 16:25:51 -0500 Subject: [PATCH 1/2] Move license to it's own file. Easier to see what the license is when first encountering the repo --- LICENSE.md | 21 +++++++++++++++++++++ README.md | 24 +----------------------- 2 files changed, 22 insertions(+), 23 deletions(-) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..b366c5dc --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +## License +(The MIT License) + +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. diff --git a/README.md b/README.md index 69dbe6fe..90434603 100644 --- a/README.md +++ b/README.md @@ -71,26 +71,4 @@ In the docs we'll try to explain both general concepts of MEAN components and gi Browse the live MEAN.JS example on [http://meanjs.herokuapp.com](http://meanjs.herokuapp.com). ## Credits -Inspired by the great work of [Madhusudhan Srinivasa](https://github.com/madhums/) - -## License -(The MIT License) - -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. +Inspired by the great work of [Madhusudhan Srinivasa](https://github.com/madhums/) \ No newline at end of file From 2f6427aa42486a2ddb31e520852fce6e929ef996 Mon Sep 17 00:00:00 2001 From: Michael Cole Date: Mon, 14 Apr 2014 17:06:13 -0500 Subject: [PATCH 2/2] Update README.md to include where to download the MEAN.JS boilerplate --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 90434603..38ab836d 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,12 @@ $ sudo npm install -g grunt-cli ## Quick Install Once you've installed all the prerequisites, you're just a few steps away from starting to develop you MEAN application. +The easiest way to use MEAN.JS as a boilerplate is to download a copy from the [master branch on github][https://github.com/meanjs/mean/archive/master.zip]. +``` +$ wget https://github.com/meanjs/mean/archive/master.zip -O MEANJS.zip; unzip MEANJS.zip; rm MEANJS.zip +``` +Rename `mean-master` after your project and create your own git repo. If you'd like to contribute code back to MEAN.JS from your project, see here (tbd). + The first thing you should do is install the Node.js dependencies. The boilerplate comes pre-bundled with a package.json file that contains the list of modules you need to start your application, to learn more about the modules installed visit the NPM & Package.json section. To install Node.js dependencies you're going to use npm again, in the application folder run this in the command-line: