diff README.md @ 81:c06dcab17923 v2.1

*: change license to BSD, update README for Unicode src/gui: use tchar.h for unicode instead of our own macros
author Paper <paper@paper.us.eu.org>
date Fri, 22 Mar 2024 22:04:16 -0400
parents 79ef211750de
children 7d4db3e24487
line wrap: on
line diff
--- a/README.md	Wed Mar 20 17:09:43 2024 -0400
+++ b/README.md	Fri Mar 22 22:04:16 2024 -0400
@@ -1,29 +1,34 @@
 # msvpvf
 C port of [msvpvf](https://archive.org/details/msvpvf-1.3-movie-studio-vegas-pro-version-faker-msvpvf-updated-to-1.31-focus-on-vegas)
 
-![msvpvf CI](https://github.com/mrpapersonic/msvpvf/actions/workflows/build.yml/badge.svg)
+## What is this??
+msvpvf is a tool used to "downgrade" VEGAS Pro project files, written entirely
+in C.
 
-## What is this??
-msvpvf is a tool used to "downgrade" VEGAS Pro project files, written entirely in C. It has no runtime libraries, making it incredibly lightweight. Binaries for OS X and Windows are less than a megabyte in size.
-
-Currently, the GUI doesn't look that great. Making pretty apps with `windows.h` is not the easiest job in the world; if someone is willing enough to make it look prettier, be my guest.
-
-It is based on an old tool under the same name that was written in C#/.NET, but the original website is now down and it hasn't been maintained in over 2 years.
+It is based on an old tool under the same name that was written in C#/.NET,
+but it's horribly slow for what it does (set some magic bytes at some offsets)
 
 # Compatibility
 There are 3 generations of modern Vegas project files:
 
-Gen 1 | Gen 2 | Gen 3
---- | --- | ---
-8.0 - 11.0 | 12.0 - 14.0 | 15.0 - Now
+Gen 1      | Gen 2       | Gen 3 onwards |
+---------- | ----------- | ------------- |
+8.0 - 11.0 | 12.0 - 14.0 | 15.0 - ???    |
 
-Any version in Gen 3 cannot be ported to Gen 2, and Gen 2 cannot be ported to Gen 1. That's just too complicated for a simple bit modifier. **However**, any file created in an older Vegas will work in a newer one.
+I haven't used any Vegas version after 14, so I have no idea if this even works
+for newer versions anymore.
 
 ## Compilation
 ```
 git clone https://github.com/mrpapersonic/msvpvf
 cd msvpvf
+
+# CLI (macos/linux, unicode filenames are unsupported on Windows)
 make
+
+# windows GUI application
+# set the two UNICODE flags to 0 or 1 for ANSI and Unicode respectfully
+make gui CFLAGS="-DUNICODE=0 -D_UNICODE=0"
 ```
 
 NOTE: if you are using Windows, there is a GUI available. To compile it, use `make gui`.