From 0942f82e898584dc8986b3d20c8e0447a8dec865 Mon Sep 17 00:00:00 2001 From: Martin Read Date: Mon, 10 Feb 2014 16:11:24 +0000 Subject: [PATCH] Added patch acceptance policy notes in README.md --- README.md | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index aab2efb..731daf5 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,36 @@ -## Copyright +## Supported environments + +Victrix Abyssi currently only supports the Linux kernel, GNU Make, and the GNU toolchain for C/C++. However, patches to support other copyleft or permissively licensed kernels and/or toolchains will usually be considered in a favorable light. + +Patches to build Victrix Abyssi for proprietary kernels and/or with proprietary toolchains will not be carried in-tree. + +Bugs and/or build failures which *only* occur when running on proprietary kernels and/or building with proprietary toolchains will be treated as being of 'wishlist' severity. + +## Library dependencies + +Victrix Abyssi currently depends on the following libraries: + +* libncursesw5 (i.e. "wide" NCurses) and libpanel +* libxdg-basedir -Victrix Abyssi's source code is copyright © 2005-2014 Martin Read, and is released under a BSD-style license as reproduced in the file COPYING. +Patches, in the form of a separate implementation of display-(whatever).cc, to support other display/input libraries will be considered on their merits. + +## Build dependencies + +Victrix Abyssi currently depends on the following tools during the build process: + +* GNU Make +* GNU Compiler Collection C++ and C compilers, version 4.7.2 or later +* Perl 5 ## Build notes -\./configure must be run before +On Unix-like systems, the standard build-from-source sequence for system-wide installation ( \./configure && make all && sudo make install ) should work as expected. + +If you wish to install the game to a directory owned by the user you are logged in as, run \./configure --prefix=/your/install/path && make all && make install + +## Copyright + +Victrix Abyssi's source code is copyright © 2005-2014 Martin Read, and is released under a BSD-style license as reproduced in the file COPYING in the top-level directory of the source tree. -- 2.11.0