mirror of
https://github.com/irmen/prog8.git
synced 2024-11-18 04:08:58 +00:00
Clarified instructions of how to obtain the compiler. Fixed sphinx css config issue.
This commit is contained in:
parent
3a2498401d
commit
13f5b94c3e
@ -16,7 +16,7 @@ Then you can choose a few ways to get a compiler:
|
|||||||
#. download a recent "fat-jar" (called something like "prog8compiler-all.jar") from `the releases on Github <https://github.com/irmen/prog8/releases>`_
|
#. download a recent "fat-jar" (called something like "prog8compiler-all.jar") from `the releases on Github <https://github.com/irmen/prog8/releases>`_
|
||||||
#. run the compiler with "java -jar prog8compiler-all.jar" to see how you can use it.
|
#. run the compiler with "java -jar prog8compiler-all.jar" to see how you can use it.
|
||||||
|
|
||||||
**using the Gradle build system to make it yourself:**
|
**Using the Gradle build system to build it yourself:**
|
||||||
|
|
||||||
The Gradle build system is used to build the compiler.
|
The Gradle build system is used to build the compiler.
|
||||||
The most interesting gradle commands to run are probably:
|
The most interesting gradle commands to run are probably:
|
||||||
@ -42,9 +42,10 @@ of that build task, you can start the compiler with:
|
|||||||
(You should probably make an alias...)
|
(You should probably make an alias...)
|
||||||
|
|
||||||
.. hint::
|
.. hint::
|
||||||
Development and testing is done on Linux, but the compiler should run on most
|
Development and testing is done on Linux using the IntelliJ IDEA IDE,
|
||||||
operating systems. If you do have trouble building or running
|
but the compiler should run on most operating systems that provide a fairly modern
|
||||||
the compiler on another operating system, please let me know!
|
java runtime. If you do have trouble building or running the compiler on your
|
||||||
|
operating system, please let me know!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -33,7 +33,7 @@ release = version
|
|||||||
|
|
||||||
def setup(app):
|
def setup(app):
|
||||||
# add custom css
|
# add custom css
|
||||||
app.add_stylesheet("css/customize.css")
|
app.add_css_file("css/customize.css")
|
||||||
|
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
# -- General configuration ---------------------------------------------------
|
||||||
|
@ -130,11 +130,18 @@ when the exact same program is compiled for the Commander X16 target, and run on
|
|||||||
:alt: result when run on CX16 emulator
|
:alt: result when run on CX16 emulator
|
||||||
|
|
||||||
|
|
||||||
|
Getting the compiler
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
Usually you just download a fat jar of an official released version, but you can also build
|
||||||
|
it yourself from source.
|
||||||
|
Detailed instructions on how to obtain a version of the compiler are in :ref:`building_compiler`.
|
||||||
|
|
||||||
|
|
||||||
.. _requirements:
|
.. _requirements:
|
||||||
|
|
||||||
Required tools
|
Required additional tools
|
||||||
--------------
|
-------------------------
|
||||||
|
|
||||||
`64tass <https://sourceforge.net/projects/tass64/>`_ - cross assembler. Install this on your shell path.
|
`64tass <https://sourceforge.net/projects/tass64/>`_ - cross assembler. Install this on your shell path.
|
||||||
It's very easy to compile yourself.
|
It's very easy to compile yourself.
|
||||||
@ -153,16 +160,6 @@ If you're targeting the CommanderX16 instead, there's the `x16emu <https://githu
|
|||||||
Make sure you use cx16 emulator and roms **V39 or newer**! Starting from version 6.5, prog8 targets that system version.
|
Make sure you use cx16 emulator and roms **V39 or newer**! Starting from version 6.5, prog8 targets that system version.
|
||||||
Your program may work on V38 but that will only be by luck.
|
Your program may work on V38 but that will only be by luck.
|
||||||
|
|
||||||
.. important::
|
|
||||||
**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 `IntelliJ IDEA <https://www.jetbrains.com/idea/>`_ ,
|
|
||||||
but only a Kotlin SDK installation should work as well, because the gradle tool is
|
|
||||||
used to compile everything from the commandline.
|
|
||||||
|
|
||||||
Instructions on how to obtain a prebuilt compiler are in :ref:`building_compiler`.
|
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
Loading…
Reference in New Issue
Block a user