summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArnav Bhatt <arnav@ghativega.in>2023-11-03 21:35:50 +0530
committerArnav Bhatt <arnav@ghativega.in>2023-11-03 21:44:28 +0530
commit0ca02c5ad29e64ceec43eeaaf9677cd7cccd08bc (patch)
tree04dad7b358ba68bb9fc63fc1e0e6cf346ddcd175
parent9b2de972a4d710dd43c5aa20cf0d53415b4b8a53 (diff)
proper readme and license
-rw-r--r--LICENSE5
-rw-r--r--README.md31
-rw-r--r--assets/images/app.pngbin0 -> 58520 bytes
3 files changed, 35 insertions, 1 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..a8db7f4
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,5 @@
+Copyright (C) 2023 by Arnav Bhatt <arnav@ghativega.in>
+
+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.
diff --git a/README.md b/README.md
index 79e2c17..44ef7a2 100644
--- a/README.md
+++ b/README.md
@@ -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.
diff --git a/assets/images/app.png b/assets/images/app.png
new file mode 100644
index 0000000..5ea4cec
--- /dev/null
+++ b/assets/images/app.png
Binary files differ