Update readme.md

README.md

@@ -0,0 +1,28 @@
+# Mega Man Maker Custom NSF Changer
+Made by Timothy GFO (https://gamefeveronline.gitlab.io | https://youtube.com/gamefeveronline)
+
+## What is this?
+I got tired of waiting for actual custom music to be added to Mega Man Maker. So, I made this tool for changing the nsf files on Mega Man Maker to a custom one. The awesome part is that it works while you are playing. You only need to restart the level or respawn from check point. I made this in just one day (first commit), but I expect this to improve a lot in the future.
+
+## Installation
+You will need to install through PIP the package PySimpleGUI. The rest of the dependencies *should* be already installed.
+
+## Usage
+This is really early in development, use at your own risk and make backups of the MegaManMaker folder before you attempt to use it. It has *not* been tested on Windows. If you want to use this, do not press the Replace NSF Music Button more than once at the same time, instead first click restore original_music, then you can replace the nsf once again. (will be fixed)
+To use it just type "python mmm-nsf-changer.py" in the terminal or commandline, and the GUI will launch. Maybe CLI support will come in the future.
+
+## Support
+If you have any issues, which is probable, make a gitlab issue. There *will* be bugs.
+
+## Roadmap
+Make it so if you click twice the Replace NSF Music button it doesn't replace the original_music folder
+Ability to change only the level music and leave the menu, or just the menu and leave the level music.
+Instead of duplicating a single file a lot of times, maybe I'll implement symlink support.
+Check through MMM Api if a new version was released and show a popup in that case.
+add autoupdater??
+
+## Contributing
+You can help with the project by testing it and reporting issues, or by making pull requests.
+
+## License
+For open source projects, say how it is licensed.