From 03b3841d3dabfbfe8be5a25020f16f521f206332 Mon Sep 17 00:00:00 2001
From: EliyaFishman <45822259+EliyaFishman@users.noreply.github.com>
Date: Thu, 8 Dec 2022 23:00:02 +0200
Subject: [PATCH] Update readme to be normal

---
 Assets/Editor/bread2unity/README.md | 46 ++++++++++++++---------------
 1 file changed, 22 insertions(+), 24 deletions(-)

diff --git a/Assets/Editor/bread2unity/README.md b/Assets/Editor/bread2unity/README.md
index d66baf00e..ab45b5ef6 100644
--- a/Assets/Editor/bread2unity/README.md
+++ b/Assets/Editor/bread2unity/README.md
@@ -1,30 +1,28 @@
 # bread2unity
-Rhythm Heaven animation to Unity animation converter
+
+bread2unity is a tool that allows you to convert Rhythm Heaven animation files (BCCAD) to Unity animation files.
+
+## Preparations
+
+1. Download [Bread](https://github.com/rhmodding/bread)
+2. Obtain Rhythm Heaven Megamix RomFS and extract the BCCAD and sprite sheet files. 
 
 
-### TODO
+## Usage
 
-- [X] add option for rotate texture
+1. Open your BCCAD file in Bread
+2. Go to the toolbar, select "Tools", and then choose "bread2unity"
+3. Select the prefab of your game
+4. View the animations in Bread and decide how to split them into game objects. For each game object you need to:
+   1. Give the game object a name in the name field
+   2. Use Bread to find the animation indexes of the animations the game object should have. Write them in the animation field separated by a comma (e.g. 0,1,2,3,4)
+   3. Decide which sprite should be the default sprite and copy the sprite index from Bread and put it in the sprite index field
+5. If more than one game object needs to be imported from the BCCAD file, use the plus button to add another row of fields. You can delete a row with the minus button.
+6. If the sprite sheet you want to use is rotated to the right, check the "Rotate Spritesheet" checkbox.
+7. Click on "Generate Assets", select the BCCAD and PNG files and your files will be generated.
 
-- [ ] remove npe (animationController)
+## Notes
 
-- [x] change animations save location
-
-- [x] refactor files
-
-- [X] add color animations
-- [X] add rotation from steps
-- [X] add scale from steps
-- [x] add translation from steps
-
-- [X] remove bccad test
-- [X] add default line for bcaad data
-- [X] change window height and width
-- [x] fix imports
-- [X] change sprite order with sprite renderer.
-
-- [ ] write a normal readme
-
-### Bugs
-- [X] fix camera taking pictures
-- [X] mices are on top of frame (photo 16)
\ No newline at end of file
+Not all of the features the BCCAD file can contain were implemented in this tool:
+1. Interpolation was not implemented due to a lack of documentation about how it works.
+2. Screen Color was not implemented due to the fact that it requires a shader to be implemented and only a small amount of games use this feature.
\ No newline at end of file