|
1 | 1 | <div align="center"> |
2 | | - <img src="img\logo.png" alt="logo" width="150" height="auto" /> |
| 2 | + <img src="https://content.2000ad.com/Alpha_NoBZGradient_Horizontal.png" alt="logo" width="80%" height="auto" /> |
| 3 | +<!-- <img src="img\logo.png" alt="logo" width="150" height="auto" /> --> |
3 | 4 | <h1>Battlezone II GameWatch</h1> |
4 | 5 | <p align="center"> |
5 | 6 | <a href = ""><img src="https://img.shields.io/github/languages/top/BattlezoneScrapField/BZCC-Website" alt="Languages" /></a> |
|
8 | 9 | </p> |
9 | 10 | </div> |
10 | 11 |
|
11 | | -Website to pull multiplayer game data for [Battlezone: Combat Commander](https://store.steampowered.com/app/624970/Battlezone_Combat_Commander/), prioritizing VSR strategy matches hosted by the Battlezone and BZ2 Strategy Discord Communities. |
| 12 | +Website to pull multiplayer game data for [Battlezone: Combat Commander](https://store.steampowered.com/app/624970/Battlezone_Combat_Commander/), hosted by the Battlezone and BZ2 Strategy Discord Communities. |
12 | 13 |
|
13 | 14 | ## Tech Stack 👾 |
14 | 15 | - Styled using [Bootstrap](http://getbootstrap.com/docs/). |
@@ -36,17 +37,25 @@ Website to pull multiplayer game data for [Battlezone: Combat Commander](https:/ |
36 | 37 | --> |
37 | 38 | </table> |
38 | 39 |
|
39 | | -## Credits: |
| 40 | +## Getting Started 🚀 |
| 41 | +We'd be happy to have you contribute to this project! Here's how you can contribute: |
40 | 42 |
|
| 43 | +### Local Environment |
| 44 | +- Clone this repo to your local pc. |
| 45 | +- Change `useCORSProxy` in `main.js:line 16` to **true**. |
| 46 | +- Open up `index.html` using the _Open with Live Server_ extension. |
| 47 | + |
| 48 | +### Pushing Changes |
| 49 | +> Note: the branching process looks like: `your-dev-branch → master → prod` |
| 50 | +
|
| 51 | +- Commit your changes to a **new** branch, sourced from `master`. You may call your branch whatever you like (i.e., `"dev-john-cooke"`). |
| 52 | +- Create a **Pull Request** to the `master` branch from your newly developed branch. Make sure to give it an adequate title, description, and label! |
| 53 | +- Now, sit back and relax! 🏖️ _From here: a code reviewer will review your commits and changes to complete the merge. If your changes look great, your PR to `master` will be approved, which means your new branch `"dev-john-cooke"` will be squashed. A member of the team will create a new PR to merge your changes (that are now in `master`) into `prod`. This will trigger the automated deployment to GitHub Pages!_ |
| 54 | + |
| 55 | +## Credits 💪 |
| 56 | +- Honoring the original foundation built by Sev. 💪 |
41 | 57 | - Game Data API created by Nielk1 ([Github](https://github.com/Nielk1) | [Twitter](https://x.com/nielk1)). ⚙️ |
42 | 58 | - ODF data provided by [AI_Unit](https://discord.com/users/125055986632228865). 📄 |
43 | 59 | - Map size data provided by [VTrider](https://github.com/VTrider) ([Github](https://github.com/VTrider) | [Steam](https://steamcommunity.com/id/vtrider/)). 🗺️ |
44 | 60 | - Map scrap loose data provided by [Blue Banana](https://www.twitch.tv/blue_banana_bz2). 📍 |
45 | | -- Honoring the original foundation built by Sev. 💪 |
46 | | -- Website maintained by by [F9bomber](https://www.youtube.com/@F9bomber) and Battlezone Community. 📊 |
47 | | - |
48 | | -## Getting Started [WIP] |
49 | | - |
50 | | -- Clone repo to your local pc |
51 | | -- Change useCORSProxy in main.js:line 16 to true. |
52 | | -- Open index.html using Open with Live Server extension. |
| 61 | +- Website maintained by [F9bomber](https://www.youtube.com/@F9bomber) and the Battlezone Community. 💖 |
0 commit comments