From 13f5b94c3e829245bbbbe0326880e042b3ec2f18 Mon Sep 17 00:00:00 2001 From: Irmen de Jong Date: Thu, 3 Jun 2021 21:21:44 +0200 Subject: [PATCH] Clarified instructions of how to obtain the compiler. Fixed sphinx css config issue. --- docs/source/building.rst | 9 +++++---- docs/source/conf.py | 2 +- docs/source/index.rst | 21 +++++++++------------ 3 files changed, 15 insertions(+), 17 deletions(-) diff --git a/docs/source/building.rst b/docs/source/building.rst index 3b87e6c9f..3352bb974 100644 --- a/docs/source/building.rst +++ b/docs/source/building.rst @@ -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 `_ #. 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 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...) .. hint:: - Development and testing is done on Linux, but the compiler should run on most - operating systems. If you do have trouble building or running - the compiler on another operating system, please let me know! + Development and testing is done on Linux using the IntelliJ IDEA IDE, + but the compiler should run on most operating systems that provide a fairly modern + java runtime. If you do have trouble building or running the compiler on your + operating system, please let me know! diff --git a/docs/source/conf.py b/docs/source/conf.py index 89d7d53b3..fc85728f8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -33,7 +33,7 @@ release = version def setup(app): # add custom css - app.add_stylesheet("css/customize.css") + app.add_css_file("css/customize.css") # -- General configuration --------------------------------------------------- diff --git a/docs/source/index.rst b/docs/source/index.rst index d0755517e..e4fcc846a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 +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: -Required tools --------------- +Required additional tools +------------------------- `64tass `_ - cross assembler. Install this on your shell path. It's very easy to compile yourself. @@ -153,16 +160,6 @@ If you're targeting the CommanderX16 instead, there's the `x16emu `_ , - 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:: :maxdepth: 2