update-README
This commit is contained in:
parent
c8b3c3c44f
commit
0d4d05a2f3
3 changed files with 14 additions and 23 deletions
9
COPYING.md
Normal file
9
COPYING.md
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
The LGPL 2.1 or any later version
|
||||||
|
|
||||||
|
marisa-rs - Safe Rust wrapper for the marisa-trie C++ library. Copyright (C) 2025 Soma Nakamura
|
||||||
|
|
||||||
|
This library 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 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library 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.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
|
@ -2,9 +2,10 @@
|
||||||
name = "marisa-rs"
|
name = "marisa-rs"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
description = "Safe Rust wrapper for the marisa-trie C++ library - a static memory-efficient trie data structure. Requires marisa-trie system library."
|
description = "Safe Rust wrapper for the marisa-trie C++ library"
|
||||||
license = "MIT OR Apache-2.0"
|
license = "LGPL-2.1-or-later"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
|
repository = "https://git.centraworks.net/centra/marisa-rs"
|
||||||
homepage = "https://crates.io/crates/marisa-rs"
|
homepage = "https://crates.io/crates/marisa-rs"
|
||||||
keywords = ["trie", "string", "search", "marisa"]
|
keywords = ["trie", "string", "search", "marisa"]
|
||||||
categories = ["data-structures", "text-processing"]
|
categories = ["data-structures", "text-processing"]
|
||||||
|
|
|
||||||
23
README.md
23
README.md
|
|
@ -13,20 +13,6 @@ Add this to your `Cargo.toml`:
|
||||||
marisa-rs = "0.1"
|
marisa-rs = "0.1"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
This crate requires the marisa-trie C++ library to be installed on your system.
|
|
||||||
|
|
||||||
### Ubuntu/Debian
|
|
||||||
```bash
|
|
||||||
sudo apt-get install libmarisa-dev
|
|
||||||
```
|
|
||||||
|
|
||||||
### macOS
|
|
||||||
```bash
|
|
||||||
brew install marisa-trie
|
|
||||||
```
|
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
```rust
|
```rust
|
||||||
|
|
@ -168,11 +154,6 @@ All types (`Keyset`, `Trie`, `Agent`) implement `Send` and can be transferred be
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under either of
|
This project is licensed under LGPL, Version 2.0
|
||||||
|
|
||||||
* Apache License, Version 2.0
|
This crate is built on top of the excellent [marisa-trie](https://github.com/s-yata/marisa-trie) library by Susumu Yata.
|
||||||
* MIT license
|
|
||||||
|
|
||||||
at your option.
|
|
||||||
|
|
||||||
This crate is built on top of the excellent [marisa-trie](https://github.com/s-yata/marisa-trie) library by Susumu Yata.
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue