added README

README.md

@@ -0,0 +1,57 @@
+# User Bit Decoder
+
+## Correct Recording Format (in camera)
+
+The 4 digits for userbit are by default `00:00:00:00`.
+They act as hex digits, but are not decoded for readability.
+This means that the code `01:01:10:02` is scene 10 shot 2, not scene 16 shot 2.
+
+The order for digits is:
+```
+Act : Scene : Reel : Shot
+```
+If any of the digits are `00`, they will default to `01` instead, so the program
+doesnt crash.
+
+Based off of the timecode embedded in the file, clips are ordered and automatically
+gain take numbers, the "newest" clip being marked as good.
+
+
+## Usage
+
+You need `pyexiftool` installed for this script to work, as well as `exiftool` and `ffmpeg`.
+These are all provided by the flake.
+
+### Nix flake
+1. Copy `STREAM` folder into an empty dir
+2. Make the `output` folder
+3. Run this repo's default package with `nix run git+https://git.voidarc.co.uk/voidarc/userBitDecoder`
+4. Profit
+
+### Local script
+1. Drag and drop the `STREAM` folder into the same relative dir as `translate.py`.
+2. Make the `output` folder
+3. Run the script
+
+## Editing
+
+The final file name will look something like the following:
+```
+R16S3.6-ACT1_SCENE7_SHOT3_TAKE6_GOOD.mov
+```
+The file name is purely for human readablility, and so that scenes are grouped
+together in the file browser. Flat file structure means that relinking is not difficult
+
+When the script has finished, it will provide a csv that can be used to apply the
+correct metadata in davinci. This csv also applies the reel number as a keyword,
+so that davinci auto categorises the different reels into smart bins.
+
+In order to import the csv, in davinci, go to `File > Import Metadata To > Media Pool`.
+Match only by file name for best results. This will automatically apply all given information.
+Multiple csv outputs can be overlaid, as long as there are no duplicated shots.
+
+> [!WARNING]
+> TAKES ARE NOT PERSISTENT BETWEEN RUNS! IF A FILE WITH THE SAME NAME IS FOUND IN THE
+> OUTPUT DIRECTORY IT WILL BE OVERWRITTEN! It is good practice to manage clips that you are editing
+> on in a different directory, rather than having a monolithic output directory that has no warnings
+> when writing over existing files. Ffmpeg doesn't respect your existing files.