diff options
| author | Niall Douglas (s [underscore] sourceforge {at} nedprod [dot] com) <spamtrap@nedprod.com> | 2018-08-23 11:43:31 +0300 |
|---|---|---|
| committer | Niall Douglas (s [underscore] sourceforge {at} nedprod [dot] com) <spamtrap@nedprod.com> | 2018-08-23 11:43:31 +0300 |
| commit | 0b0eae81e199476a1f5246c68011bd00d8653363 (patch) | |
| tree | 6cf170cd57bb8bb57aaa80addfee08fd4d4a15da | |
| parent | 1c7209c3b928bacb43e1391ed7523f63c5385816 (diff) | |
Add rudimentary usage instructions.
| -rw-r--r-- | Readme.md | 4 | ||||
| -rw-r--r-- | release_notes.md | 7 |
2 files changed, 9 insertions, 2 deletions
@@ -8,6 +8,8 @@ Tarballs of source and prebuilt binaries for Linux x64, MacOS x64 and Windows x6 - https://dedi5.nedprod.com/static/files/llfio-v2.0-binaries-darwin64-latest.tgz (disabled pending XCode supporting Filesystem TS) - https://dedi5.nedprod.com/static/files/llfio-v2.0-binaries-win64-latest.zip +USAGE AND CONFIGURATION INSTRUCTIONS CAN BE FOUND AT https://ned14.github.io/llfio/ + ### Immediate todos in order of priority: - [x] Implement new custom C++ exception synthesis support from Outcome. @@ -20,7 +22,7 @@ Tarballs of source and prebuilt binaries for Linux x64, MacOS x64 and Windows x6 - [x] Implement SG14 `status_code` as a standalone library and test in LLFIO. - [x] Single include generation now we're on `status_code` and it's safe. - [x] Implement `SIGBUS`/`EXCEPTION_IN_PAGE_ERROR` RAII catcher. -- [ ] Implement `symlink_handle` already! +- [x] Implement `symlink_handle` already! - [ ] `atomic_append` isn't actually being tested in shared_fs_mutex - [ ] Implement a non-toy ACID key-value BLOB store and send it to Boost for peer review. - [ ] For this need to implement a file-based B+ tree. And for that, need to diff --git a/release_notes.md b/release_notes.md index 0e1b136b..dd1b5145 100644 --- a/release_notes.md +++ b/release_notes.md @@ -21,7 +21,7 @@ filesystem algorithms which work well with directly mapped non-volatile storage as Intel Optane. It is a complete rewrite after a Boost peer review in August 2015. Its github -source code repository lives at https://github.com/ned14/boost.llfio. +source code repository lives at https://github.com/ned14/llfio. - Portable to any conforming C++ 14 compiler with a working Filesystem TS in its STL. - Will make use of any Concepts TS if you have them. @@ -60,6 +60,11 @@ for a database of latencies for various previously tested OS, filing systems and Todo list for already implemented parts: https://ned14.github.io/llfio/todo.html +LLFIO defaults to header only library configuration, so you don't actually need any of the prebuilt +binaries above. It is however faster to build if you do. In this situation, define `LLFIO_HEADERS_ONLY=0`, +and choose one of `LLFIO_DYN_LINK` or `LLFIO_STATIC_LINK` depending on whether you are using the +prebuilt shared or static libraries respectively. + To build and test (make, ninja etc): ~~~ |