Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fniephaus committed Aug 1, 2018
1 parent 4fae844 commit e3d3b9b
Showing 1 changed file with 2 additions and 21 deletions.
23 changes: 2 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A [Squeak/Smalltalk][squeak] implementation for the [GraalVM][graalvm].
Oracle Labs JDK's home directory.
4. Run [`bin/graalsqueak`][graalsqueak] to build and start GraalSqueak with
[mx] using the Oracle Labs JDK.
5. Open the pre-configured
5. Open a pre-configured
[Squeak/Smalltalk image for GraalSqueak][graalsqueak_image]
(incl. [VMMaker] for BitBlt/Balloon simulation).

Expand Down Expand Up @@ -41,20 +41,6 @@ It is recommended to use [Eclipse Oxygen][eclipse_oxygen] with the
Run `mx --help` to list all commands that may help you develop GraalSqueak.


### Running The Tests

To run the entire test pipeline, execute [`scripts/run-tests.sh`][run_tests]
which cleans, builds, and tests GraalSqueak.
Additionally and before GraalSqueak is built, all Java sources are analyzed with
[Checkstyle] and [FindBugs].
Each step can also be invoked separately with [mx].

It is possible to run JUnit tests with Eclipse.
Please note that the Squeak/Smalltalk test image must exist on disk if you want
to run the [`SqueakSUnitTest`][sunit] TestCase.
Run [`scripts/download-test-image.sh`][test_image] to download it.


### Running Specific Squeak/Smalltalk Code

It is often useful to execute specific Squeak/Smalltalk code for debugging
Expand All @@ -74,28 +60,23 @@ Please [report any issues here on GitHub][issues] and open



[checkstyle]: http://checkstyle.org/
[codacy]: https://app.codacy.com/app/fniephaus/graalsqueak/dashboard
[codacy_badge]: https://api.codacy.com/project/badge/Coverage/9748bfe3726b48c8973e3808549f6d05
[dev]: ../../tree/dev
[eclipse_cs]: http://checkstyle.org/eclipse-cs/
[eclipse_oxygen]: https://www.eclipse.org/oxygen/
[findbugs]: http://findbugs.sourceforge.net/
[graal]: https://github.com/oracle/graal
[graalsqueak]: bin/graalsqueak
[graalsqueakmain]: src/de.hpi.swa.graal.squeak/src/de/hpi/swa/graal/squeak/GraalSqueakMain.java
[graalsqueak_image]: https://dl.bintray.com/hpi-swa-lab/GraalSqueak/images/graal-squeak-image-18067.zip
[graalsqueak_image]: https://github.com/hpi-swa-lab/graalsqueak/releases/latest
[graalvm]: http://www.graalvm.org/
[graalvm_download]: http://www.graalvm.org/downloads/
[issues]: ../../issues/new
[labsjdk]: http://www.oracle.com/technetwork/oracle-labs/program-languages/downloads/index.html
[master]: ../../tree/master
[mx]: https://github.com/graalvm/mx
[pull_request]: ../../compare/dev...
[run_tests]: scripts/run-tests.sh
[squeak]: https://squeak.org
[sunit]: src/de.hpi.swa.graal.squeak.test/src/de/hpi/swa/graal/squeak/test/SqueakSUnitTest.java
[test_image]: scripts/download-test-image.sh
[travis]: https://travis-ci.com/hpi-swa-lab/graalsqueak
[travis_badge]: https://travis-ci.com/hpi-swa-lab/graalsqueak.svg?token=7fqzGEv22MQpvpU7RhK5&branch=master
[vmmaker]: http://source.squeak.org/VMMaker/

0 comments on commit e3d3b9b

Please sign in to comment.