diff options
Diffstat (limited to 'README.html')
-rw-r--r-- | README.html | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/README.html b/README.html index 7c1a794..6a732ac 100644 --- a/README.html +++ b/README.html @@ -1,12 +1,12 @@ <!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>rgo (<b>R</b>untime-al<b>GO</b>rithmic, pronounced as <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> + <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 is being reflected for a future release.</p> <br /> <p>rgo is written in GNU C and GNU assembly for the following machine architectures:</p> <ul> @@ -14,17 +14,18 @@ <p>AMD64 (x86-64), including (Planned) AVX;</p> </li> <li> - <p><i>(Planned) Aarch64 (ARM64), including SVE;</i></p> + <p>IA-32 (i386), including SSE and (Planned) AVX;</p> + <p><i>Note: Support is currently limited to: memcpy, memeq, memfill.</i></p> </li> <li> - <p><i>(Planned) IA-32 (i386), including SSE and AVX;</i></p> + <p><i>(Planned) Aarch64 (ARM64), including SVE;</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> + <p>The provided makefile has been tested to work with GNU make and BSD make and should work with other make implementations.</p> + <p>The target <i>rgo</i> builds the static library file (located at <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 of <i>test.c</i>.</p> <br /> <h2>Copyright and License</h2> <p>Copyright 2022 Gabriel Jensen</p> |