scratchfoundation/scratchjr
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratchjr.git synced 2024-11-28 18:15:37 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #12 from tmickel/docs

Browse source 
License, CONTRIBUTING, update README, package.json
This commit is contained in:
chrisgarrity 2016-02-10 14:35:45 -05:00
commit 39a281793c
4 changed files with 42 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,10 @@
## Contributing
Here are some ways you can contribute to ScratchJr:
* Report bugs
* If you find bugs in ScratchJr, please let us know! Please be as descriptive as possible and include screenshots if possible.
* Work on bugs and make pull requests
* If you have made a fix for a bug, please make a pull request! Fork the scratchjr repository, make the code changes. Please provide an explanation of what you have changed, a link to the relevant bug, and how your changes fix the bug. All code that's merged into ScratchJr must pass our linter (`npm run lint`). We'll review your changes and hopefully merge them into the project, benefiting all users of ScratchJr!
* [README](https://github.com/LLK/scratchjr/blob/master/README.md)
* [Scratch Community Guidelines](https://github.com/LLK/scratch-www/wiki/Community-Guidelines)
* [Issues](https://github.com/LLK/scratchjr/issues)

12
LICENSE Normal file
View file

@ -0,0 +1,12 @@
Copyright (c) 2015, Massachusetts Institute of Technology
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

21
README.md
View file

@ -2,18 +2,13 @@
This is the official git repository hosting the source code for the
[ScratchJr](http://scratchjr.org/) project.
ScratchJr cannot be copied and/or distributed without the express
permission of the Massachusetts Institute of Technology (MIT). You should
only access this repository if you have been given explicit permission
from MIT.
ScratchJr can be built both on iOS and Android.
ScratchJr can be built both for iOS and Android.
A pure-web version or Chrome-app version is planned to follow at some point in the future.
Platform | Status
-------- | -------------
iOS | Released in App Store
Android | Released in Google Play
Android | Released in Google Play and Amazon store
## Release Schedule
@ -43,6 +38,11 @@ This repository has the following directory structure:
## Building ScratchJr
To build the Android version, you need to have a system equipped with Android Studio. To build the iOS version, you need to have a Mac with XCode.
Ensure you have node and npm [installed](http://blog.npmjs.org/post/85484771375/how-to-install-npm).
With all of the code checked out, you must install npm dependencies for bundling the JavaScript:
* <tt>npm install</tt>
The build caches .png files out of the .svg files to improve performance. To enable this build step, you need to install a few dependencies.
On Ubuntu:
@ -60,6 +60,13 @@ On OS X:
Once these are installed, select the appropriate target in XCode or the appropriate flavor/build variant in Android Studio.
## Where and how to make changes
All changes should be made in a fork. Before making a pull request, ensure all changes pass our linter:
* <tt>npm run lint</tt>
For more information, see [CONTRIBUTING.md](CONTRIBUTING.md).
## Code credits
ScratchJr would not be possible without free and open source libraries, including:
* [Snap.svg](https://github.com/adobe-webplatform/Snap.svg/)

9
package.json
View file

@ -2,13 +2,16 @@
"name": "scratchjr",
"version": "1.2.0",
"description": "ScratchJr",
"private": "true",
"scripts": {
"lint": "eslint src/**",
"build": "webpack"
},
"author": "MIT Media Lab",
"license": "MIT",
"author": "MIT Media Lab, Tufts University, Playful Invention Company",
"license": "BSD-3-Clause",
"bugs": {
"url": "https://github.com/llk/scratchjr/issues"
},
"homepage": "https://github.com/llk/scratchjr",
"devDependencies": {
"babel-core": "^6.4.0",
"babel-eslint": "^4.1.6",