From 1a85b4035367a223eb2183c421c12be243f1c430 Mon Sep 17 00:00:00 2001 From: George Sokianos Date: Wed, 2 Feb 2022 13:37:32 +0000 Subject: [PATCH] Updated the documentation to reflect the latest changes. --- Makefile | 2 +- README.md | 19 ++++++++++--------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/Makefile b/Makefile index ead01e6..69aed6c 100644 --- a/Makefile +++ b/Makefile @@ -22,7 +22,7 @@ help: @echo " into it. Not suitable to compile adtools" @echo "compile [GCC=x] - Create a container with the latest Docker image and get" @echo " into it to compile adtools with GCC 8 (default) or the" - @echo " defined one by GCC parameter. Possible values 8/9/10/11." + @echo " defined one by GCC argument. Possible values 6/8/9/10/11." @echo "clonerepos - Clone the necessary repositories under repos folder." @echo "pullrepos - Pull the latest code for the projects under repos folder." @echo "clean - Remove the docker container, if this still exists." diff --git a/README.md b/README.md index 4688b25..b5a0a52 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # adtoolsBuilder -This is docker images that can be used to build native adtools for AmigaOS 4 on every operating system that supports Docker. +This is a docker image that can be used to build native adtools for AmigaOS 4 on any operating system that supports Docker. ## Setup -To prepare the environment you need to do the following: +To prepare the development environment you need to do the following: 1. Clone the necessary repos under the `repos` folder ```bash @@ -22,24 +22,25 @@ To prepare the environment you need to do the following: ```bash make build ``` - This will create the walkero/adtoolsbuilder:adtools-build Docker image, with size around 1.88GB. So make sure you have this available space at your hard disk. + This will create the walkero/adtoolsbuilder:adtools-build Docker image, with the size of around 1.88GB. So make sure you have this available space on your hard disk. -After this steps you are ready to compile the adtools on your machine. +After these steps, you are ready to compile the adtools on your machine. ## Compile adtools -To compile adtools you first need to create a Docker container based on which GCC version you want to build. Available versions are 6, 8, 10, 11. To do that you just need to run the following: +To compile adtools you first need to create a Docker container based on which GCC version you want to build. Available versions are 6, 8, 9, 10, 11. To do that you just need to run the following: ```bash -make gcc8 +make compile GCC=8 ``` -Change the number based on which version you would like to compile. +Change the number based on which version you would like to compile. By default, if GCC argument is missing, is set to compile GCC 8. Then you can execute the `build-gcc.sh` script to run all the steps, or do them by hand. -**CAUTION:** Because of a bug, the `make native-install` command might fail the first time you run it, but it will succeed if you run it a second time. That's why it is recommended to execute the commands by hand, until this bug is fixed. +**CAUTION:** Because of a bug, the `make native-install` command might fail the first time you run it, but it will succeed if you run it a second time. That's why it is recommended to execute the commands by hand until this bug is fixed. ## Useful information 1. When you start a container to compile adtools in there, a new folder will be created named `native-gcc`. In there new folders will be created with the gcc files and the distribution lha packages for adtools and clib. This way you can get those files from the host machine. 2. By default, the adtools is compiled using the latest AmigaOS 4 SDK v53.34. If you would like to compile them using the previous v53.30, then open the `Makefile` and change the `makefile-SDK53.34` to `makefile-SDK53.30`. By doing that the latest ExecSG private SDK is not used, and you can have an empty folder under `repos` directory. 3. If you don't have the latest ExecSG private SDK, then check the above line on what to do. -4. If you want to update the cloned repos and rebuild the Docker image, just run `make buildnc`. This will pull the latest code for the necessary repos and will re-create the Docker image. The files `native-build/Makefile`, `gcc-build/features.mk` and `gcc-build/Makefile` are not updated though, because custom ones are used. If there are updates at the adtools repo, these need to be applied manually, with caution. The custom files can be found under `files/` folder. \ No newline at end of file +4. If you want to update the cloned repos and rebuild the Docker image, just run `make buildnc`. This will pull the latest code for the necessary repos and will re-create the Docker image. The files `native-build/Makefile`, `gcc-build/features.mk` and `gcc-build/Makefile` are not updated though, because custom ones are used. If there are updates at the adtools repo, these need to be applied manually, with caution. The custom files can be found under `files/` folder. +5. To get a list of the available parameters of make script, you can run `make help` or just `make`. \ No newline at end of file