rintyuu/MikuMikuBeam
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update CONTRIBUTING.md

Browse source 
Fixed some of the text as c0d1ng-ma5ter requested and changed some text a bit
This commit is contained in:
James 2025-01-30 22:14:02 -08:00 • committed by GitHub
parent f22dc73100
commit b597d9be9e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
CONTRIBUTING.md
View file

@ -1,19 +1,16 @@
# Contributing to MikuMikuBeam! # Contributing to MikuMikuBeam!
Welcome! before you start makeing **ANY** issues. (or requests) ***Did you***? Welcome! before you start making an issue. Did you first
- Have carefully **READ** the entirely [Setup](https://github.com/sammwyy/MikuMikuBeam?tab=readme-ov-file#setup-%EF%B8%8F) and [Installation](https://github.com/sammwyy/MikuMikuBeam?tab=readme-ov-file#installation-)? - Have carefully **READ** the [Setup](https://github.com/sammwyy/MikuMikuBeam?tab=readme-ov-file#setup-%EF%B8%8F) and [Installation](https://github.com/sammwyy/MikuMikuBeam?tab=readme-ov-file#installation-) before?
- open the terminal or command prompt in your Miku folder? (psst, clone or download the repo first and then enter it) - 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 server?) first? - 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. - run `git pull` # to be in the latest version.
- Make `proxies.txt` amd `uas.txt` if it doesn't exist in the data folder. (if it does exist then ignore this part.) - 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 terminal (im assuming you are useing ubuntu, or windows terminal....) - 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! - and then run `npm run dev` to start the server!
- then go to [localhost:5173](http://localhost:5173/) - then go to [localhost:5173](http://localhost:5173/) and at last, it should show like this. (If it doesn't show up, you broke or forgot to install something.)
and it should look like this! (Im useing Dark reader but you will see the same thing. The "active bots" number will be diffrent for each user)
![Dark mode](https://github.com/user-attachments/assets/7407c4b8-7952-4b26-ae2d-6772a537f466) ![Dark mode](https://github.com/user-attachments/assets/7407c4b8-7952-4b26-ae2d-6772a537f466)
Last of all, please check for existing issues before reporting any issues.
### 🐛 Reporting Issues ### 🐛 Reporting Issues
If you find a bug or have a feature request, please open an [issue](https://github.com/sammwyy/MikuMikuBeam/issues) and include: If you find a bug or have a feature request, please open an [issue](https://github.com/sammwyy/MikuMikuBeam/issues) and include: