History

Ivan Tatarinov db2bf6fd7c sdk: update `README.md`		2021-04-12 14:33:05 +03:00
..
bin	sdk: moved `hardware/kartusho/roms/zx7b.exe` to `sdk/bin/zx7b.exe`, added sources	2021-04-12 14:02:10 +03:00
src	sdk: moved `hardware/kartusho/roms/zx7b.exe` to `sdk/bin/zx7b.exe`, added sources	2021-04-12 14:02:10 +03:00
Makefile	sdk: moved `hardware/kartusho/roms/zx7b.exe` to `sdk/bin/zx7b.exe`, added sources	2021-04-12 14:02:10 +03:00
README.md	sdk: update `README.md`	2021-04-12 14:33:05 +03:00
README.md.license	+ added files `sdk/README.md`, `sdk/README.md.license`, `sdk/setvars.sh`, `sdk/bin/sjasmplus.exe.license`	2021-04-10 12:15:20 +03:00
common.mk	+ added files `sdk/README.md`, `sdk/README.md.license`, `sdk/setvars.sh`, `sdk/bin/sjasmplus.exe.license`	2021-04-10 12:15:20 +03:00
setvars.bat	+ added files `sdk/README.md`, `sdk/README.md.license`, `sdk/setvars.sh`, `sdk/bin/sjasmplus.exe.license`	2021-04-10 12:15:20 +03:00
setvars.sh	sdk: fix mistake in path resolving in file `sdk/setvars.sh`	2021-04-10 13:21:04 +03:00

README.md

Authors

2021 Ivan Tatarinov ivan-tat@ya.ru

Contributors

No one yet.

License

This document is under GNU FDL-1.3 or later license.

1. General information

The source code of all tools is in src directory. All compiled binaries are placed in bin directory.

1.1. Copyright and licensing information for files

We try to follow REUSE recommendations on how to easely specify copyright and licensing information to our files. So we added this information to each source file we used according to SPDX specification. Check it out by using this reuse-tool.

2. Using SDK in GNU environment on Linux, FreeBSD etc.

2.1. Build tools

Command	Target
`make`	all tools
`make bin/sjasmplus`	sjasmplus
`make bin/zx7b`	zx7b

2.2. Clean tools

To clean everything type:

make clean

2.3. Tools usage

These tools are supposed to be used mainly in Makefiles and Bash scripts invoked from Makefiles.

2.3.1. In Makefiles

To use these tools in a Makefile just include common.mk file at the beginning of one like this:

include ../sdk/common.mk

Remember to specify correct relative path to it.

This will set "ZXUNOSDK" environment variable (on first inclusion only) and update your "PATH" environment variable to point to SDK's tools. These changes are actual for current invocation of "make" utility and all child processes.

2.3.2. In Bash scripts

Bash scripts are supposed to be invoked from Makefiles where the correct environment is already prepared by "make" utility so nothing must be done for such scripts.

In other cases you must source setvars.sh file in a Bash script like this:

source ../sdk/setvars.sh

. ../sdk/setvars.sh

Remember to specify correct relative path to it.

This has the same behavior as the inclusion of common.mk file in a Makefile.

3. Using SDK in GNU environment on Windows

NOTE: compilation of the following tools:

sjasmplus
zx7b

on Windows platform is disabled right now because of presence of precompiled binaries of them in repository. They are not deleted when cleaning.

3.1. Build tools

The building process is similar to one for GNU on Linux, FreeBSD etc. See 2.1.

3.2. Clean tools

The cleaning process is similar to one for GNU on Linux, FreeBSD etc. See 2.2.

3.3. Tools usage

3.3.1. In Makefiles

The usage is similar to one for GNU/Linux, FreeBSD etc. See 2.3.1.

3.3.2. In Bash scripts

The usage is similar to one for GNU/Linux, FreeBSD etc. See 2.3.2.

4. Using SDK on Windows without GNU environment

4.1. In batch scripts

To use these tools in a batch script just call setvars.bat file at the beginning of one like this:

call ..\sdk\setvars.bat

Remember to specify correct relative path to it.

This will set "ZXUNOSDK" environment variable (on first call only) and update your "PATH" environment variable to point to SDK's tools. These changes are actual for current invocation of command shell and all child processes.