Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
twitu committed Mar 7, 2024
1 parent 38873cd commit 6428daa
Showing 1 changed file with 0 additions and 39 deletions.
39 changes: 0 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,5 @@
# ArkLib

<<<<<<< HEAD
This is the home of core ARK-Navigator library.

Being implemented in Rust, it provides us capability to port ARK-Navigator to all common platforms.\
The purpose of the library is to manage _tag storage_ and _resource index_.

**The Concept of the library**

_Resource index_ is what allows ARK-Navigator to work store metadata of files without paying attention to their paths. Basically, it is just mapping between paths and ids. Currently, ids are CRC-32 checksums but more complicated ids should be invented for a numerous reasons, see <https://github.com/ARK-Builders/ARK-Navigator/issues/147>

We call a file as "resource" in our app, because resources could be decoupled from particular filesystems in future.

_Tag storage_ is what makes files searchable using simple concept of "tags". At the moment, tag storage is just mapping between resource ids to sets of tags.

Right now, both index and storage are defined only as Kotlin code in ARK-Navigator. They are being ported into Rust.

**Interfaces to the library**

At the moment, only Android wrapper exists:\
<https://github.com/ARK-Builders/arklib-android>

This connector can be used to implement apps with capability of marking local resources with tags for future search.

**Applications using the library**

ARK-Navigator itself, which is _resource navigator_ for Android. You can think about it as file browser enabled with tags feature for any file.\
<https://github.com/ARK-Builders/ARK-Navigator>

Auxiliary tool for working with folders containing _tags_, from your laptop using terminal.\
<https://github.com/ARK-Builders/ARK-CLI>

## Prerequisites

- PDFium prebuilt ([bblanchon](https://github.com/bblanchon/pdfium-binaries))
=======
This is the home of core ARK library.

Being implemented in Rust, it provides us capability to port all our apps to all common platforms. Right now, Android is supported by using the [arklib-android](https://github.com/arK-Builders/arklib-android) project. And for Linux/macOS/Windows, the library can be used as-is and easily embedded into an app, e.g. built with [Tauri](https://tauri.app/). Development docs will come sometime.
Expand All @@ -58,7 +23,6 @@ The purpose of the library is to manage _resource index_ of folders with various
| `data-json` | JSON serialization and deserialization |

</div>
>>>>>>> main

## Build

Expand All @@ -73,8 +37,6 @@ Run unit tests:
```bash
cargo test
```
<<<<<<< HEAD
=======

## Development

Expand Down Expand Up @@ -105,4 +67,3 @@ Our benchmark suite includes tests on local files and directories. These benchma
You have the flexibility to benchmark specific files or folders by modifying the variables within the benchmark files. By default, the benchmarks operate on the [`test-assets/`](test-assets/) directory and its contents. You can change the directory/files by setting the `DIR_PATH` and `FILE_PATHS` variables to the desired values.

For pre-benchmark assessment of required time to index a huge local folder, you can modify `test_build_resource_index` test case in `src/index.rs`.
>>>>>>> main

0 comments on commit 6428daa

Please sign in to comment.