diff options
Diffstat (limited to 'README.html')
| -rw-r--r-- | README.html | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/README.html b/README.html new file mode 100644 index 0000000..a8afe7c --- /dev/null +++ b/README.html @@ -0,0 +1,33 @@ +<!DOCTYPE html> +<html> + <h1>dux</h1> + <h3><a href="https://discord.gg/UshkEdZPdM">Discord Server</a></h3> + <p><i><a href="https://mandelbrot.dk/dux">dux</a></i> is a free, open-source, and semi-portable general-purpose library for the C and C++ programming languages.</p> + <p>The main purpose of dux is to implement a clean, morden and featureful library.</p> + <o>Our primary goal is to implement this almost completely ourselves and with as few dependencies as possible. Therefore, dux may not be (and is currently not) as portable as many other libraries, with the currently supported platforms being:</p> + <ul> + <li> + <p>Aarch64, FreeBSD</p> + </li> + <li> + <p><i>Aarch64, Linux (Previously tested but currently untested)</i></p> + </li> + <li> + <p><i>AMD64, FreeBSD (Untested)</i></p> + </li> + <li> + <p>AMD64, Linux</p> + </li> + </ul> + <h2>Compiling</h2> + <p>This project uses CMake as it's build system. The option <code>DUX_ENABLE_DEMO</code> (<code>FALSE</code>|<code>TRUE</code>) enables compilation of the demo program (<code>dux-demo</code>).</p> + <h2>Contributing</h2> + <p>You may submit bug reports or suggestions on our <a href="https://discord.gg/UshkEdZPdM">Discord Server</a> in the #bug-reports and #suggestions channels respectively..</p> + <p>dux does currently not accept <i>any</i> merge requests.</p> + <h2>Copyright & License</h2> + <p>Copyright 2021, 2022 Gabriel Jensen.</p> + <p>This file is part of <i>dux</i>.</p> + <p><i>dux</i> is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p> + <p><i>dux</i> 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 Affero General Public License for more details.</p> + <p>You should have received a copy of the GNU Affero General Public License along with <i>dux</i>. If not, see <a href="https://www.gnu.org/licenses">https://www.gnu.org/licenses</a>.</p> +</html> |