Skip to content

Commit

Permalink
add readme and licence
Browse files Browse the repository at this point in the history
  • Loading branch information
aoyako committed Apr 14, 2024
1 parent a7e85a3 commit 67a2333
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 78 deletions.
7 changes: 7 additions & 0 deletions LICENCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright 2024 aoyako

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.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## HVIF-go
![master](https://github.com/aoyako/hvif/actions/workflows/golangci-lint.yml/badge.svg)

*HVIF (Haiku Vector Image File) is a file format used in Haiku OS for storage-efficient applications icon storage*

This library provides low-level access to the HVIF contents. Since this library is focused on file interactions, the returned types are mostly interfaces. Even thought originaly parser is tightly coupled with renderer, it is not a scope of this library.

The functionality includes:
1. Loading vector data to the memory
2. Storing vector data back to the file (TBI)
3. Modification of style, pathes, and shapes information

### Examples:
#### Reading image file
```go
filename := "testdata/ime.hvif"
file, _ := os.Open(filename)
img, err := ReadImage(file)
```

### Contributing
HVIF-go is an open-source library. Any contributions, such as issues and pull requests, are welcomed.

### License
HVIF-go is licensed under MIT license. See LICENSE.md file.
78 changes: 0 additions & 78 deletions example.txt

This file was deleted.

Binary file removed res/ime.hvif
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 67a2333

Please sign in to comment.