diff options
Diffstat (limited to 'README.html')
-rw-r--r-- | README.html | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/README.html b/README.html new file mode 100644 index 0000000..7c1a794 --- /dev/null +++ b/README.html @@ -0,0 +1,34 @@ +<!DOCTYPE html> +<html> + <h1>rgo</h1> + <p>rgo (<b>R</b>untime-al<b>GO</b>rithmic, pronounced <i>are-go</i>) is a C/C++ library for runtime algorithmics on memory sequences.</p> + <p><i>Note: This library is still in it's early stages and is NOT anywhere near being fully optimised.</i></p> + <br /> + <h2>Supported Platforms</h2> + <p>rgo is written (mostly) in assembly, and we therefore can't possibly support every platform in existence.</p> + <p>Currently, it's only compatible with the UNIX System-V ABI. Systems using this ABI include FreeBSD, Linux, macOS, OpenBSD, and any other System-V derivative. Support for Windows NT will be reflected.</p> + <br /> + <p>rgo is written in GNU C and GNU assembly for the following machine architectures:</p> + <ul> + <li> + <p>AMD64 (x86-64), including (Planned) AVX;</p> + </li> + <li> + <p><i>(Planned) Aarch64 (ARM64), including SVE;</i></p> + </li> + <li> + <p><i>(Planned) IA-32 (i386), including SSE and AVX;</i></p> + </li> + </ul> + <br /> + <h2>Building</h2> + <p>The provided makefile has been tested to work with GNU make and BSD make and should work on other make implementations.</p> + <p>The target <i>rgo</i> builds the static library file (<i>rgo/librgo.a</i>). The target <i>clean</i> removes all object files, whilst <i>purge</i> removes all object files and the static library file.</p> + <p>Instructions for building the test program may be found on the first line in <i>test.c</i>.</p> + <br /> + <h2>Copyright and License</h2> + <p>Copyright 2022 Gabriel Jensen</p> + <p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser 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>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 Lesser General Public License for more details.</p> + <p>You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <i>https://www.gnu.org/licenses/</i>. </p> +</html>
\ No newline at end of file |