Skip to content

Commit

Permalink
proper readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
arnavbhatt288 committed Nov 3, 2023
1 parent 9b2de97 commit 0ca02c5
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 1 deletion.
5 changes: 5 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Copyright (C) 2023 by Arnav Bhatt <[email protected]>

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,30 @@
WIP.
# Utkirna

<p align="center">
<img src="assets/images/app.png" />
</p>

## About
Utkirna is a cross-platform application heavily inspired from [Win32DiskImager](https://sourceforge.net/projects/win32diskimager/) that lets you to write a raw disk image to a removable device or backup a removable device to a raw image file. It is useful for preparing bootable drives with "dd like" images for PC, SBC and embedded development boards as well for backing up such drives.
Utkirna (devanagari: उत्कीर्ण, romanized: Utkīrṇa) means "engraved" in Sanskrit.

## Downloads
Visit the [release page](https://github.com/arnavbhatt288/utkirna/releases) to download the latest release. Pre-built binaries are available for Linux and Windows (both x86-64) for now.

## Requirements
As Utkirna compiles into a statically linked binary, there are no runtime dependency requirements. For compiling, a [Go](https://go.dev/) compiler (version 1.18 or later) and the [prerequisites for Fyne](https://developer.fyne.io/started/) is required.

## Building
Systems with the compile-time requirements satisfied can build the project using `go build` in the project root:
```bash
go build
```
Compilation can also be performed with fyne for including the [fyne metadata](https://developer.fyne.io/started/metadata/). Use the following command in the project root:
```bash
fyne build
```
## Contributing
Contributions are highly appreciated. Everything from creating bug reports to contributing code will help the project to a great degree, so feel free to help in any manner you prefer to.

## Licnese
Utkirna is licensed in `0BSD` as every software licenses is a complete meme anyway.
Binary file added assets/images/app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0ca02c5

Please sign in to comment.