Skip to content

Commit 08811c2

Browse files
authored
Merge pull request Free60Project#41 from alex-free/master
improve build-xenon-toolchain and readme
2 parents a82f866 + a0ed770 commit 08811c2

2 files changed

Lines changed: 426 additions & 400 deletions

File tree

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ docker $ make
2323

2424
### Requirements
2525

26-
Dependencies for debian
26+
Dependencies for Linux distributions using the `dnf` or `apt` package managers will automatically be installed for you. These include:
2727

2828
- flex
2929
- bison
@@ -37,37 +37,38 @@ Dependencies for debian
3737
- wget
3838
- file
3939

40-
### Environment variables
41-
42-
After installation of the toolchain, the following environment variables need to be populated.
43-
44-
`DEVKITXENON` is dependencing on your chosen installation prefix location.
45-
46-
```
47-
DEVKITXENON="/usr/local/xenon"
48-
PATH="$PATH:$DEVKITXENON/bin:$DEVKITXENON/usr/bin"
49-
```
40+
If you are not using a Linux system with either the `dnf` or `apt` package manager, ensure the above equivalents are installed before running the main driving script to setup LibXenon, which is named `toolchain/build-xenon-toolchain`. See below on how to use it.
5041

5142
### Prefix
5243

53-
If you want to choose your own prefix, prepend it to the `./build-xenon-toolchain` invocation.
54-
55-
e.g. `PREFIX=/home/username/xenon ./build-xenon-toolchain toolchain`
44+
By default the prefix is set to `/usr/local/xenon`. If you want to choose your own prefix, prepend it to the `./build-xenon-toolchain` invocation, i.e. `PREFIX="/home/username/xenon" ./build-xenon-toolchain toolchain`.
5645

57-
### Installing toolchain
46+
### Installing the toolchain
5847

5948
```
6049
./build-xenon-toolchain toolchain
6150
```
6251

63-
### Install libxenon library
52+
### Installing the libxenon library
6453

6554
```
6655
./build-xenon-toolchain libxenon
6756
```
6857

69-
### Install auxiliary libs
58+
### Installing auxiliary libs (libxenon, bin2s, zlib, libpng, bzip2, freetype, filesystems)
7059

7160
```
7261
./build-xenon-toolchain libs
7362
```
63+
64+
### Environment variables
65+
66+
After installation of the toolchain, the following environment variables need to be populated:
67+
68+
```
69+
DEVKITXENON="/usr/local/xenon"
70+
PATH="${PATH:+${PATH}:}"$DEVKITXENON"/bin:"$DEVKITXENON"/usr/bin"
71+
```
72+
`DEVKITXENON` depends on your chosen installation prefix location. The default value is `/usr/local/xenon` unless you changed it.
73+
74+
You may edit your ~/.bashrc to set these in every shell automatically. Alternatively, you may execute `./build-xenon-toolchain env-cmd` to install a command named `xenon-env`. When you run that command, it will set those variables in a new shell.

0 commit comments

Comments
 (0)