Adjust README.md to make markdownlint happy

This commit is contained in:
Christopher Willis-Ford 2019-02-04 21:49:25 -08:00
parent 74ae0cbc04
commit fbc01c42d8

View file

@ -1,20 +1,42 @@
## Scratch 2.0 editor and player [![Build Status](https://api.travis-ci.org/LLK/scratch-flash.svg?branch=master)](https://travis-ci.org/LLK/scratch-flash) # Scratch 2.0 editor and player [![Build Status](https://api.travis-ci.org/LLK/scratch-flash.svg?branch=master)](https://travis-ci.org/LLK/scratch-flash)
#### Note: Scratch 2.0 is now in maintenance mode while the team focuses efforts on [Scratch 3.0](https://scratch.mit.edu/developers). While critical issues will be addressed please note that any feature requests or minor issues will not be reviewed until the next major release. ## Note
--- **Scratch 2.0 is now in maintenance mode while the team focuses efforts on [Scratch
3.0](https://scratch.mit.edu/developers). While critical issues will be addressed please note that any feature
requests or minor issues will not be reviewed until the next major release.**
This is the open source version of Scratch 2.0 and the core code for the official version found on http://scratch.mit.edu. This code has been released under the GPL version 2 license. Forks can be released under the GPL v2 or any later version of the GPL. ## Overview
If you're interested in contributing to Scratch, please take a look at the issues on this repository. Two great ways of helping Scratch are by identifying bugs and documenting them as issues, or fixing issues and creating pull requests. When submitting pull requests please be patient -- the Scratch Team is very busy and it can take a while to find time to review them. The organization and class structures can't be radically changed without significant coordination and collaboration from the Scratch Team, so these types of changes should be avoided. This is the open source version of Scratch 2.0 and the core code for the official version found on
<http://scratch.mit.edu>. This code has been released under the GPL version 2 license. Forks can be released under the
GPL v2 or any later version of the GPL.
It's been said that the Scratch Team spends about one hour of design discussion for every pixel in Scratch, but some think that estimate is a little low. While we welcome suggestions for new features in our <a href="http://scratch.mit.edu/discuss/1/">suggestions forum</a> (especially ones that come with mockups), we are unlikely to accept PRs with new features that we haven't deeply thought through. Why? Because we have a strong belief in the value of keeping things simple for new users. To learn more about our design philosophy, see this <a href="http://scratch.mit.edu/discuss/post/1576/">forum post<a>, or <a href="http://web.media.mit.edu/~jmaloney/papers/ScratchLangAndEnvironment.pdf">this paper</a>. If you're interested in contributing to Scratch, please take a look at the issues on this repository. Two great ways
of helping Scratch are by identifying bugs and documenting them as issues, or fixing issues and creating pull
requests. When submitting pull requests please be patient -- the Scratch Team is very busy and it can take a while to
find time to review them. The organization and class structures can't be radically changed without significant
coordination and collaboration from the Scratch Team, so these types of changes should be avoided.
### Building It's been said that the Scratch Team spends about one hour of design discussion for every pixel in Scratch, but some
think that estimate is a little low. While we welcome suggestions for new features in our [suggestions
forum](http://scratch.mit.edu/discuss/1/) (especially ones that come with mockups), we are unlikely to accept PRs with
new features that we haven't deeply thought through. Why? Because we have a strong belief in the value of keeping
things simple for new users. To learn more about our design philosophy, see [this forum
post](http://scratch.mit.edu/discuss/post/1576/) or [this
paper](http://web.media.mit.edu/~jmaloney/papers/ScratchLangAndEnvironment.pdf).
The Scratch 2.0 build process now uses [Gradle](http://gradle.org/) to simplify the process of acquiring dependencies: the necessary Flex SDKs will automatically be downloaded and cached for you. The [Gradle wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) is included in this repository, but you will need a Java Runtime Environment or Java Development Kit in order to run Gradle; you can download either from Oracle's [Java download page](http://www.oracle.com/technetwork/java/javase/downloads/index.html). That page also contains guidance on whether to download the JRE or JDK. ## Building
There are two versions of the Scratch 2.0 editor that can be built from this repository. See the following table to determine the appropriate command for each version. When building on Windows, replace `./gradlew` with `.\gradlew`. The Scratch 2.0 build process now uses [Gradle](http://gradle.org/) to simplify the process of acquiring dependencies:
the necessary Flex SDKs will automatically be downloaded and cached for you. The [Gradle
wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) is included in this repository, but you will
need a Java Runtime Environment or Java Development Kit in order to run Gradle; you can download either from Oracle's
[Java download page](http://www.oracle.com/technetwork/java/javase/downloads/index.html). That page also contains
guidance on whether to download the JRE or JDK.
There are two versions of the Scratch 2.0 editor that can be built from this repository. See the following table to
determine the appropriate command for each version. When building on Windows, replace `./gradlew` with `.\gradlew`.
Required Flash version | Features | Command Required Flash version | Features | Command
--- | --- | --- --- | --- | ---
@ -55,19 +77,31 @@ build/11.6:
Scratch.swf Scratch.swf
``` ```
Please note that the Scratch trademarks (including the Scratch name, logo, Scratch Cat, and Gobo) are property of MIT. For use of these Marks, please see the [Scratch Trademark Policy](http://wiki.scratch.mit.edu/wiki/Scratch_1.4_Source_Code#Scratch_Trademark_Policy). Please note that the Scratch trademarks (including the Scratch name, logo, Scratch Cat, and Gobo) are property of MIT.
For use of these Marks, please see the [Scratch Trademark
Policy](http://wiki.scratch.mit.edu/wiki/Scratch_1.4_Source_Code#Scratch_Trademark_Policy).
## Debugging
### Debugging
Here are a few integrated development environments available with Flash debugging support: Here are a few integrated development environments available with Flash debugging support:
* [Visual Studio Code](https://code.visualstudio.com/)
* [Intellij IDEA](http://www.jetbrains.com/idea/features/flex_ide.html) * [Intellij IDEA](http://www.jetbrains.com/idea/features/flex_ide.html)
* [Adobe Flash Builder](http://www.adobe.com/products/flash-builder.html) * [Adobe Flash Builder](http://www.adobe.com/products/flash-builder.html)
* [FlashDevelop](http://www.flashdevelop.org/) * [FlashDevelop](http://www.flashdevelop.org/)
* [FDT for Eclipse](http://fdt.powerflasher.com/) * [FDT for Eclipse](http://fdt.powerflasher.com/)
It may be difficult to configure your IDE to use Gradle's cached version of the Flex SDK. To debug the Scratch 2.0 SWF with your own copy of the SDK you will need the [Flex SDK](http://flex.apache.org/) version 4.10+, and [playerglobal.swc files](http://helpx.adobe.com/flash-player/kb/archived-flash-player-versions.html#playerglobal) for Flash Player versions 10.2 and 11.4 added to the Flex SDK. It may be difficult to configure your IDE to use Gradle's cached version of the Flex SDK. To debug the Scratch 2.0 SWF
with your own copy of the SDK you will need the [Flex SDK](http://flex.apache.org/) version 4.10+, and
[playerglobal.swc files](http://helpx.adobe.com/flash-player/kb/archived-flash-player-versions.html#playerglobal) for
Flash Player versions 10.2 and 11.6 added to the Flex SDK.
After downloading ``playerglobal11_4.swc`` and ``playerglobal10_2.swc``, move them to ``<path to flex>/frameworks/libs/player/<version>/playerglobal.swc``. E.g., ``playerglobal11_4.swc`` should be located at ``<path to flex>/frameworks/libs/player/11.4/playerglobal.swc``. After downloading ``playerglobal11_6.swc`` and ``playerglobal10_2.swc``, move them to
``${FLEX_HOME}/frameworks/libs/player/${VERSION}/playerglobal.swc``. E.g., ``playerglobal11_6.swc`` should be located
at ``${FLEX_HOME}/frameworks/libs/player/11.6/playerglobal.swc``.
Consult your IDE's documentation to configure it for your newly-constructed copy of the Flex SDK. Consult your IDE's documentation to configure it for your newly-constructed copy of the Flex SDK.
If the source is building but the resulting .swf is producing runtime errors, your first course of action should be to download version 4.11 of the Flex SDK and try targeting that. The Apache foundation maintains an [installer](http://flex.apache.org/installer.html) that lets you select a variety of versions. If the source is building but the resulting .swf is producing runtime errors, your first course of action should be to
download version 4.11 of the Flex SDK and try targeting that. The Apache foundation maintains an
[installer](http://flex.apache.org/installer.html) that lets you select a variety of versions.