diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6af8480..27bcc68 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,16 @@ # 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-)? -- open the terminal or command prompt in your Miku folder? (psst, 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 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? (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` amd `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....) +- 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](http://localhost:5173/) -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) +- 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.) ![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 If you find a bug or have a feature request, please open an [issue](https://github.com/sammwyy/MikuMikuBeam/issues) and include: