From 4570311385ced815e96da51336b4b6ef32cc7198 Mon Sep 17 00:00:00 2001 From: belliash Date: Thu, 23 Nov 2023 22:22:08 +0100 Subject: [PATCH] Import readme and license. --- COPYING.md | 6 +++--- README.md | 31 ++++++++++++++++++++++--------- 2 files changed, 25 insertions(+), 12 deletions(-) diff --git a/COPYING.md b/COPYING.md index 32b38d4..85c7c69 100644 --- a/COPYING.md +++ b/COPYING.md @@ -595,17 +595,17 @@ pointer to where the full notice is found. Copyright (C) - + This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - + You should have received a copy of the GNU General Public License along with this program. If not, see . diff --git a/README.md b/README.md index cd5f0d1..46519e5 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,28 @@ ## XT Toolchain -This is an the XT toolchain based on MinGW-W64. It currently supports C and C++, and provides -a variety of tools. It can be used to build both Windows and XT software, including XT OS. +This is a LLVM/Clang/LLD based mingw-w64 toolchain. It currently supports C and C++, and provides +a variety of tools including IDL, message and resource compilers. The XT Toolchain is also the +official build environment for compiling XT software, including the FerretOS. Currently, it is +targeted at Linux host only, however it should be possible to build it in MSYS2 as well. -This repository contains 2 branches: - * gnu-toolchain: This is the GCC/Binutils based mingw-w64 toolchain. - * llvm-toolchain: This is the LLVM/Clang/LLD based mingw-w64 toolchain. +Benefits of a LLVM based MinGW toolchain are: + * Single toolchain targeting all architectures (i686, x86_64, armv7 and aarch64), + * Support for generating debug info in PDB format, + * Support for targeting ARM/AARCH64 architectures and ability to produce Windows ARM binaries. + +This software includes: + * CMake + * LLVM + * Make + * Mingw-w64 + * Ninja + * Wine + +This software is based on ["LLVM MinGW Toolchain"](https://github.com/mstorsjo/llvm-mingw). ## Licensing -The XTchain project includes the scripts for building and assembling a toolchain as well as other -scripts and wrappers. These are licensed under the GPLv3 license. It covers only mentioned -components that are provided by XTchain directly. For more information on that, refer to +The XTchain project includes the scripts for building and assembling a toolchain as well as wrappers +for LLVM tools and environmental shell. These are licensed under the GPLv3 license. It covers only +mentioned components that are provided by XTchain directly. For more information on that, refer to the COPYING.md file. The final pre-built toolchain is covered by the licenses of the individual, external projects. The full list of software incorporated into this toolchain is available in the -README.md file in the corresponding branch. +README.md file.