Skip to content

Commit

Permalink
cleaned up some buildprocess scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
irmen committed Jul 11, 2019
1 parent 845a99d commit 7c9b8f7
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 79 deletions.
27 changes: 17 additions & 10 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,32 +143,39 @@ Finally: a **C-64 emulator** (or a real C-64 ofcourse) to run the programs on. T
of the `Vice emulator <http://vice-emu.sourceforge.net/>`_.

.. important::
**Building the compiler itself:**
**Building the compiler itself:** (*Only needed if you have not downloaded a pre-built 'fat-jar'*)

(re)building the compiler itself requires a recent Kotlin SDK.
The compiler is developed using the `IntelliJ IDEA <https://www.jetbrains.com/idea/>`_
IDE from Jetbrains, with the Kotlin plugin (free community edition of this IDE is available).
But a bare Kotlin SDK installation should work just as well.

A shell script (``create_compiler_jar.sh``) is provided to build and package the compiler from the command line.
If you have the 'fat-jar' you can run it with ``java -jar prog8compiler.jar``.
You can also use the Gradle build system to build the compiler (it will take care of
downloading all required libraries for you) by typing ``gradle build`` for instance.
The output of this gradle build will appear in the "./compiler/build/install/p8compile/" directory.

If you have the 'fat-jar' you can run it with ``java -jar prog8compiler.jar`` or just use
one of the scripts that are created by Gradle

The Gradle build system is used to build the compiler.
The most interesting gradle commands to run are probably:

``./gradlew check``
Builds the compiler code and runs all available checks and unit-tests.
``./gradlew installDist``
Builds the compiler and installs it with scripts to run it, in the directory
``./compiler/build/install/p8compile``
``./gradlew installShadowDist``
Creates a 'fat-jar' that contains the compiler and all dependencies,
and a few start scripts to run it.
Creates a 'fat-jar' that contains the compiler and all dependencies, in a single
executable .jar file, and includes few start scripts to run it.
The output can be found in ``.compiler/build/install/compiler-shadow/``
and you can launch the compiler with the script
``./compiler/build/install/compiler-shadow/bin/p8compile``.
``./gradlew shadowDistZip``
Creates a zipfile with the above in it, for easy distribution.
This file can be found in ``./compiler/build/distributions/``

For normal use, the ``installDist`` target should suffice and ater succesful completion
of that build task, you can start the compiler with:

``./compiler/build/install/p8compile/bin/p8compile <options> <sourcefile>``

(You should probably make an alias...)

.. note::
Development and testing is done on Linux, but the compiler should run on most
Expand Down
33 changes: 0 additions & 33 deletions old_scripts/build_the_compiler.sh

This file was deleted.

9 changes: 0 additions & 9 deletions p8compile.cmd

This file was deleted.

9 changes: 0 additions & 9 deletions p8compile.sh

This file was deleted.

9 changes: 0 additions & 9 deletions p8vm.cmd

This file was deleted.

9 changes: 0 additions & 9 deletions p8vm.sh

This file was deleted.

File renamed without changes.
File renamed without changes.

0 comments on commit 7c9b8f7

Please sign in to comment.