Apple-2-SW/prog8
1
0
Fork 0
mirror of https://github.com/irmen/prog8.git synced 2024-07-22 08:29:01 +00:00
Code Issues Projects Releases Wiki Activity

fix build script docs

Browse Source
This commit is contained in:
Irmen de Jong 2019-07-02 04:56:31 +02:00
parent ac70ae6a76
commit fd0abf61df
2 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/source/building.rst
View File

@ -5,27 +5,28 @@ Writing and building a program
First, getting a working compiler
---------------------------------
Before you can compile Prog8 programs, you'll have to build the compiler itself.
Before you can compile Prog8 programs, you'll have to download or build the compiler itself.
First make sure you have installed the :ref:`requirements`.
Then you can choose a few ways to create the compiler:
Then you can choose a few ways to get a compiler:
**Using the shell script:**
#. run the "build_the_compiler.sh" shell script
#. it will create a "prog8compiler.jar" file which contains everything.
#. run the compiler with "java -jar prog8compiler.jar" to see how you can use it.
**using the Gradle build system:**
#. run the command "./gradlew installDist"
#. it will create the commands and required libraries in the "./compiler/build/install/p8compile/" directory
#. run the compiler with the "./compiler/build/install/p8compile/bin/p8compile" command to see how you can use it.
**download a precompiled version from github:**
**Download a precompiled version from github:**
#. download a recent "prog8compiler.jar" from `the releases on Github <https://github.com/irmen/prog8/releases>`_
#. run the compiler with "java -jar prog8compiler.jar" to see how you can use it.
**Using the shell scripts:**
#. run the "create_compiler_jar.sh" shell script and have a little patience while everything is built
#. it will output "prog8compiler.jar" file which contains everything.
#. run the compiler with "java -jar prog8compiler.jar" to see how you can use it.
**using the Gradle build system directly:**
#. run the command "./gradlew installDist" and have a little patience while everything is built
#. it will create the commands and required libraries in the "./compiler/build/install/p8compile/" directory
#. run the compiler with the "./compiler/build/install/p8compile/bin/p8compile" command to see how you can use it.
What is a Prog8 "Program" anyway?
---------------------------------

2
docs/source/index.rst
View File

@ -155,7 +155,7 @@ of the `Vice emulator <http://vice-emu.sourceforge.net/>`_.
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 (``build_the_compiler.sh``) is provided to build and package the compiler from the command line.
A shell script (``create_compiler_jar.sh``) is provided to build and package the compiler from the command line.
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 installDist`` for instance.
The output of this gradle build will appear in the "./compiler/build/install/p8compile/" directory.