Add Readmedev

1 files changed, 44 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..786e18a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# cbconv
+
+Work in progress to reverse engineer the proprietary Cubase/Nuendo project file
+format.
+
+## Why?
+
+A long time ago I happened to make several projects in Cubase for Mac OS X.
+Since I no longer use OS X, nor Cubase anymore, I would like to be able to
+convert these projects to an open format that I can use in free- and open
+source digital audio workstations.
+
+For now the focus is on reverse engineering the actual file format.
+
+## How?
+
+The project is written in the [Rust programming language] and using the [`nom`
+library] for the actual parsing.
+
+## What's the status?
+
+Parsing the version chunk is almost complete, but apart from that pretty much
+everything else is still to be figured out. I'm currently trying to work my
+way through the arrangement chunk, but progress is slow and sporadic.
+
+## Can I help?
+
+Absolutely! Get in touch if you have any ideas or suggestions, or just want to
+keep up with what's going on. I'd be very grateful for any insights into the
+file format you may have, even if you don't want to get your hands dirty with
+`nom` or Rust.
+
+You can reach me through the [audioplugins mailing list], or find my email in
+the repository commits. You'll also find me on the fediverse as [@harald@hub.volse.no].
+
+## License
+
+cbconv is free software under the GPL-3.0-or-later license. See the `LICENSES`
+directory for details.
+
+[Rust programming language]: https://www.rust-lang.org/
+[`nom` library]: https://crates.io/crates/nom
+[audioplugins mailing list]: https://listserv.volse.net/info/audioplugins
+[@harald@hub.volse.no]: https://hub.volse.no/channel/harald