rintyuu/MikuMikuBeam
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
MikuMikuBeam/CONTRIBUTING.md
James b597d9be9e
Update CONTRIBUTING.md 
Fixed some of the text as c0d1ng-ma5ter requested and changed some text a bit
2025-01-30 22:14:02 -08:00

1.5 KiB
Raw Blame History

Contributing to MikuMikuBeam!

Welcome! before you start making an issue. Did you first

  • Have carefully READ the Setup and Installation before?
  • open the terminal or command prompt in your Miku folder? (clone or download the repo first and then enter it)
  • Have Node.js (v14 or above) and npm installed onto your pc or on your linux server first.
  • run git pull # to be in the latest version.
  • Make proxies.txt and uas.txt if it doesn't exist in the data folder. (if it does exist then ignore this part.)
  • run npm install in the same terminal (Im assuming that you are using ubuntu, or windows terminal..)
  • and then run npm run dev to start the server!
  • then go to localhost:5173 and at last, it should show like this. (If it doesn't show up, you broke or forgot to install something.) Dark mode

🐛 Reporting Issues

If you find a bug or have a feature request, please open an issue and include:

  • A clear and descriptive title.
  • Steps to reproduce (if applicable).
  • Expected vs. actual behavior.
  • Relevant screenshots or logs.

🔧 Submitting a Pull Request (PR)

  1. Fork the repository and create a new branch: 
    git checkout -b feature/your-feature