shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2024-12-22 17:35:55 +03:00
Code Issues Projects Releases Wiki Activity

libostree: add metadata, readme, and license file

Browse Source
This commit is contained in:
Felix Krull 2018-10-17 23:13:24 +02:00 committed by Colin Walters
parent eee83b38b4
commit dfab03486b
3 changed files with 68 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
rust-bindings/rust/libostree/Cargo.toml
View File

@ -1,8 +1,15 @@
[package]
name = "libostree"
version = "0.1.0"
authors = ["Felix Krull"]
documentation = "https://fkrull.gitlab.io/rust-libostree/libostree"
license = "MIT"
license-file = "LICENSE"
description = "Rust bindings for libostree"
keywords = ["ostree", "libostree"]
repository = "https://gitlab.com/fkrull/rust-libostree"
readme = "README.md"
[package.metadata.docs.rs]
features = ["dox"]

21
rust-bindings/rust/libostree/LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2018 Felix Krull
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

39
rust-bindings/rust/libostree/README.md Normal file
View File

@ -0,0 +1,39 @@
# Rust bindings for libostree
libostree is both a shared library and suite of command line tools that combines a "git-like" model for committing and
downloading bootable filesystem trees, along with a layer for deploying them and managing the bootloader configuration.
The core OSTree model is like git in that it checksums individual files and has a content-addressed-object store. It's
unlike git in that it "checks out" the files via hardlinks, and they thus need to be immutable to prevent corruption.
[libostree site](https://ostree.readthedocs.io) | [libostree git repo](https://github.com/ostreedev/ostree)
This project provides [Rust](https://rust-lang.org) bindings for libostree. They are automatically generated, but rather
incomplete as of yet.
## Setup
The `libostree` crate requires libostree and the libostree development headers. On Debian/Ubuntu, they can be installed
with:
```ShellSession
$ sudo apt-get install libostree-1 libostree-dev
```
To use the crate, add it to your `Cargo.toml`:
```toml
[dependencies]
libostree = "0.1"
```
To use features from later libostree versions, you need to specify the release version as well:
```toml
[dependencies.libostree]
version = "0.1"
features = ["v2018_7"]
```
## License
The libostree crate is licensed under the MIT license. See the LICENSE file for details.
libostree itself is licensed under the LGPL2+. See its [licensing information](https://ostree.readthedocs.io#licensing)
for more information.