Initial commit

README.md

@@ -0,0 +1,25 @@
+# proto-creator
+
+A protobuf message GUI editor. This allows protobuf messages (including JSON formatted messages) stored on disk to be created and edited based on `.proto` definnition files.
+
+## Contributing
+
+### Requirements
+
+Rust and Node must be installed at a minimum.
+
+### Build
+
+To build an installer, run `bun run tauri build`, or whatever whatever the equivalent binary is for your node runtime.
+
+### Code Formatting
+
+Use rust-analyzer and you won't need to worry about rust formatting, please use prettier for formatting front-end/angular related files.
+
+### Recommended IDE Setup
+
+[VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) + [Angular Language Service](https://marketplace.visualstudio.com/items?itemName=Angular.ng-template).
+
+### Troubleshooting
+
+If building in VS Code on macOS, and you get a message `Error failed to bundle project: error running bundle_dmg.sh`, run the build in a terminal outside of VS Code. This error is occurring as VS Code doesn't have the required file permissions.