Add basic readme (#6)

Author: RBogie

README.md

@@ -0,0 +1,85 @@
+# Snip
+
+Snip is a simple, cross-platform text editor inspired by Boop. It aims to improve on Boop by adding cross-platform support, better handling of large files, enhanced syntax highlighting, and the ability to operate on files. Snip maintains a focus on easy scripting, quick startup, and usefulness as a small notepad for copying and editing snippets.
+
+## Features
+
+- **Cross-Platform Support**: Available on macOS, Windows[^1], and Linux[^1].
+- **Handling of Large Files**: Efficiently handles large files without performance degradation.
+- **Syntax Highlighting**: Syntax highlighting for various programming languages.
+- **File Operations[^1]**: Ability to open, edit, and save files.
+- **Easy Scripting**: Simple and powerful scripting capabilities.
+- **Quick Startup**: Fast startup time, making it ideal for quick edits.
+- **Notepad Functionality**: Useful as a small notepad for copying and editing snippets.
+
+[^1]: Not yet supported, but coming soon
+
+## Screenshots
+
+![Screenshot 1](docs/screenshots/main_dark.png)
+![Screenshot 2](docs/screenshots/main_light.png)
+
+## Installation
+
+### macOS
+
+Download the .dmg from the [releases page](https://github.com/SnipEditor/snip/releases). Open the archive and move the Snip application to your 'Applications' folder.
+
+> [!NOTE]
+> Opening the archive or opening the application for the first time requires you to open through the context menu in finder, since the application is signed but not notarized
+
+### Windows
+
+TODO: Currently windows support is not yet implemented. Support will arrive in the near future
+
+### Linux
+
+TODO: Currently linux support is not yet implemented. Support will arrive in the near future
+
+## Usage
+
+To start Snip, simply run the binary
+
+## Building from Source
+
+### Prerequisites
+
+- Rust
+- Cargo
+- Node.js
+- Yarn
+
+### Steps
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/SnipEditor/snip.git
+   cd snip
+   ```
+
+2. Install dependencies:
+
+   ```bash
+   yarn install
+   ```
+
+3. Run the application in development mode:
+
+   ```bash
+   yarn tauri dev
+   ```
+
+4. (To build a standalone executable):
+
+   ```bash
+   yarn tauri build
+   ```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Acknowledgements
+
+- Inspired by [Boop](https://github.com/IvanMathy/Boop)