From a497e4267f14937dbdd587c97e0639557e5cb041 Mon Sep 17 00:00:00 2001 From: Oskari Alaranta Date: Wed, 15 Apr 2026 17:54:40 +0300 Subject: [PATCH] Add README and LICENSE --- LICENSE | 24 ++++++++++++++++++++++++ README.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7ae44a1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,24 @@ +BSD 2-Clause License + +Copyright (c) 2026, Oskari Alaranta + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..d8c8979 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# xbanan + +An X11 compatibility layer for [banan-os's](https://git.bananymous.com/Bananymous/banan-os) native GUI windowing system. + +## Running on linux + +### Building +```sh +git clone --recursive https://git.bananymous.com/Bananymous/xbanan.git +cd xbanan + +cd banan-os +git apply ../0001-linux-window-server-sdl2.patch +cd .. + +cmake -B build -S . -G Ninja +cmake --build build +``` + +### Running + +To start the WindowServer, run the following command in project root +```sh +./build/banan-os/userspace/programs/WindowServer/WindowServer +``` +To run X11 apps specify `DISPLAY=:69` environment variable. For example +```sh +DISPLAY=:69 xeyes +```