centra/marisa-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update-README

Browse source
This commit is contained in:
Soma Nakamura 2025-07-24 02:33:46 +09:00
parent c8b3c3c44f
commit 0d4d05a2f3
3 changed files with 14 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
COPYING.md Normal file
View 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

5
Cargo.toml
View file

@ -2,9 +2,10 @@
name = "marisa-rs"
version = "0.1.0"
edition = "2021"
description = "Safe Rust wrapper for the marisa-trie C++ library - a static memory-efficient trie data structure. Requires marisa-trie system library."
license = "MIT OR Apache-2.0"
description = "Safe Rust wrapper for the marisa-trie C++ library"
license = "LGPL-2.1-or-later"
readme = "README.md"
repository = "https://git.centraworks.net/centra/marisa-rs"
homepage = "https://crates.io/crates/marisa-rs"
keywords = ["trie", "string", "search", "marisa"]
categories = ["data-structures", "text-processing"]

23
README.md
View file

@ -13,20 +13,6 @@ Add this to your `Cargo.toml`:
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
```rust
@ -168,11 +154,6 @@ All types (`Keyset`, `Trie`, `Agent`) implement `Send` and can be transferred be
## License
This project is licensed under either of
This project is licensed under LGPL, Version 2.0
* Apache License, Version 2.0
* 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.
This crate is built on top of the excellent [marisa-trie](https://github.com/s-yata/marisa-trie) library by Susumu Yata.