add readme

niivue · Apr 17, 2024 · 8d6bc92 · 8d6bc92
1 parent 45ffce8
commit 8d6bc92
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,34 @@
+# Niivue iOS
+
+The Niivue iOS applications allow users to view, draw, and segment medical images in formats commonly used in medical research. 
+
+The native components of the application are written in Swift, and the medical images are rendered using Niivue in a web view.
+
+## Features
+
+- View MRI/CT images in common formats used in medical research
+- Draw and segment images (Apple Pencil is supported as a touch device)
+- Save and load images from the local device (no data is sent to a server)
+- Works in Airplane mode
+- Customise viewing optons (e.g. window/level, zoom/pan, etc.)
+- Multiple layouts supported
+- Save drawings to Files app on iPhone/iPad
+
+## macOS support
+
+The Niivue iOS application is is primarily designed for iPhone and iPad, but it can also be run on macOS as long as the macOS machine has an Apple Silicon chip (ARM).
+
+# App screenshots
+
+## iPhone
+![iphone](./screenshots/iphone.png)
+
+# iPad
+![ipad](./screenshots/ipad.png)
+
+# MacOS
+![macos](./screenshots/macos.png)
+
+## Development - Getting Started
+
+TBD
diff --git a/screenshots/ipad.png b/screenshots/ipad.png
diff --git a/screenshots/iphone.png b/screenshots/iphone.png
diff --git a/screenshots/macos.png b/screenshots/macos.png