Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance README.md #1

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 41 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,44 @@
# React + Vite
[![Link](https://raw.githubusercontent.com/YoruKiwi/Mario-Bros.js/patch-1/public/logo.png)](https://mario-bros-js-one.vercel.app/)

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:
# Welcome to Mario Bros.js, a JavaScript/WebGL Mario Bros project!
<div align="center">
<a href="https://github.com/Lunakepio/Mario-Bros.js/stargazers"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/Lunakepio/Mario-Bros.js"></a>
<a href="https://github.com/Lunakepio/Mario-Bros.js/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>
<a href="https://github.com/Lunakepio/Mario-Bros.js/actions/workflows/deploy-to-gh-pages.yml"><img alt="Github Actions" src="https://img.shields.io/github/actions/workflow/status/Lunakepio/Mario-Bros.js/deploy-to-gh-pages.yml"></a>
</div>

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Lunakepio/Mario-Bros.js)

⚠️ DISCLAIMER : Please note that this project is still in progress, so your patience is appreciated as we work on it. Enjoy !
<br><br>

### ✨ Our Contributors
<a href="https://github.com/Lunakepio/Mario-Bros.js/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Lunakepio/Mario-Bros.js" />
</a>


## ⬇️ Installation
To get started, follow these steps:

1. Fork the repository
2. Clone the repository or download it
3. Open your terminal and inside the project folder, run :
```bash
npm install
```
4. Start the dev server
```bash
npm run dev
```

## 🕹️ Gameplay Controls
### Keyboard [AZERTY]
- Use the <kbd>Q</kbd> key to go left.
- Use the <kbd>D</kbd> key to go right.
- Use the <kbd>SpaceBar</kbd> key to jump.
- Use the <kbd>Shift</kbd> key to go sprint.

### Gamepad
⚠️ Not yet implemented.
Binary file added public/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.