Skip to content

Commit 1bd491f

Browse files
committed
docs(README): add new sections and make it more clear
1 parent 419d5eb commit 1bd491f

File tree

1 file changed

+63
-40
lines changed

1 file changed

+63
-40
lines changed

README.md

+63-40
Original file line numberDiff line numberDiff line change
@@ -14,57 +14,80 @@
1414
<img >
1515
</div>
1616

17-
# 📃 Table of content
17+
## 📃 Table of content
1818

1919
- [🚀 Goal of the project](#-goal-of-the-project)
2020
- [🧑‍💻 Installation](#-installation)
2121
- [🛠 Installation on Windows / Linux](#-installation-on-windows--linux)
22-
- [🛠 Installation Locally](#-installation-locally)
22+
- [💻 Installation Locally](#-installation-locally)
2323
- [🎮 How to Play](#-how-to-play)
24+
- [🎥 Gameplay](#-gameplay)
2425
- [🙏Contributing](#contributing)
2526
- [🌍 Support](#-support)
26-
- [✍️ Licence](#-licence)
27-
- [👨 Creators](#-creators)
27+
- [✍️ Licence](#-licence)
28+
- [👨 Creators](#-author)
2829

29-
# 🚀 Goal of the project
30+
## 🚀 Goal of the project
3031

3132
> [!NOTE]
3233
> I initially developed a very basic game in 2022 and created multiple issues to encourage contributions from the community. The main goal of this repository is not just to build a game, but to provide an open-source project where everyone can contribute step by step.
3334
34-
# 🧑‍💻 Installation
35+
## 🧑‍💻 Installation
3536

3637
> [!IMPORTANT]
3738
> Be aware to download the version of [Open JDK 21](https://jdk.java.net/archive/) before installing. I bet you can download any JDK you want, it just needs to be version 21.
3839
> Run the command `java --version` to make sure Java 21 is installed.
3940
40-
## 🛠 Installation on Windows / Linux
41-
42-
- Click [here](https://github.com/jvondermarck/dinosaur-exploder/tags) and look at the last release you will found, to download the `dinosaur-exploder.jar` executable.
43-
- Then in a console, type the following command:
44-
45-
```console
46-
$> java -jar dinosaur-exploder.jar
47-
```
48-
49-
## 🛠 Installation Locally
50-
51-
> You should not need to download [Java FX](https://openjfx.io/openjfx-docs/#introduction) and FXGL on your local computer because it should be downloaded when syncing the Maven project.
52-
53-
- To install the project locally, [`fork` our repository](https://github.com/jvondermarck/dinosaur-exploder/fork), and in an empty directory,
54-
type the following command to `clone` your fork :
55-
56-
```console
57-
$> git clone [email protected]: <user>/dinosaur-exploder.git
58-
```
59-
60-
- Make sure to sync the Maven project in your IDE (you could use IntelliJ IDEA)
61-
62-
- Run the game :
63-
- On your IDE : hit play on your IDE and select the `com.dinosaur.dinosaurexploder.DinosaurApp` target where it contains the main.
64-
- With an executable : generate a `jar` file with the command `mvn package` and then `java -jar target/dinosaur-exploder-1.0.jar`
65-
- On the web : run the command `mvn jpro:run` and the game should be available at `http://localhost:8080/`
66-
67-
# 🎮 How to Play
41+
### 🛠 Installation on Windows / Linux / Mac
42+
43+
🚀 **Quick Start**:
44+
1. **Download the latest release** ➡️ [Click here](https://github.com/jvondermarck/dinosaur-exploder/tags) and grab the latest `dinosaur-exploder.jar`.
45+
2. **Run the game** by executing the following command in your terminal:
46+
```console
47+
$ java -jar dinosaur-exploder.jar
48+
```
49+
50+
### 💻 Installation Locally
51+
52+
💡 **No need to install** [JavaFX](https://openjfx.io/openjfx-docs/#introduction) or FXGL manually—Maven will handle dependencies automatically!
53+
54+
#### 📥 Clone the repository
55+
1. **Fork** the repository ➡️ [`Click here`](https://github.com/jvondermarck/dinosaur-exploder/fork).
56+
2. In your terminal, run:
57+
```console
58+
$ git clone [email protected]:<your-username>/dinosaur-exploder.git
59+
```
60+
61+
#### 🏗️ Build & Run
62+
63+
➡️ **Using an IDE (Recommended)**
64+
- Open the project in **IntelliJ IDEA** (or any Java IDE).
65+
- Sync the Maven project.
66+
- Run the main class:
67+
- Locate `com.dinosaur.dinosaurexploder.DinosaurApp`.
68+
- Hit **Run** ▶️
69+
70+
➡️ **Using the Command Line**
71+
- **Generate the JAR**:
72+
```console
73+
$ mvn package
74+
```
75+
- **Run the game**:
76+
```console
77+
$ java -jar target/dinosaur-exploder-1.0.jar
78+
```
79+
80+
➡️ **Run in the Browser**
81+
- Start a local web server:
82+
```console
83+
$ mvn jpro:run
84+
```
85+
- Open **http://localhost:8080/** 🌐
86+
87+
> 📖 **Need more details?**
88+
> Check out our **[installation guide](https://github.com/jvondermarck/dinosaur-exploder/wiki/Documentation#dinosaur-exploder-documentation)** for in-depth instructions!
89+
90+
## 🎮 How to Play
6891

6992
Play the game with these controls:
7093

@@ -76,16 +99,16 @@ Play the game with these controls:
7699
- 🔫 <kbd>Space</kbd>: shoot.
77100
- 💥 <kbd>B</kbd>: eliminate all the dinosaurs on the screen using a bomb.
78101

79-
# Gameplay
102+
## 🎥 Gameplay
80103

81104
https://github.com/user-attachments/assets/9dbad492-b600-4a14-9367-11eef2a7834a
82105

83-
# 🙏Contributing
106+
## 🙏 Contributing
84107

85108
> [!TIP]
86109
> I am very much open to contributions - please read our [code of conduct](https://github.com/jvondermarck/dinosaur-exploder/blob/main/CODE_OF_CONDUCT.md) and [contribution guidelines](https://github.com/jvondermarck/dinosaur-exploder/blob/main/CONTRIBUTING.md) first.
87110
88-
# 🌍 Support
111+
## 🌍 Support
89112

90113
**Any question ? 🦖 Feel free to write us something :**
91114

@@ -94,13 +117,13 @@ https://github.com/user-attachments/assets/9dbad492-b600-4a14-9367-11eef2a7834a
94117
- You can post an article on our [Website blog](https://dinosaur-exploder.freecluster.eu/forum).
95118
- For quick communication, feel free to join our [Discord server](https://discord.com/invite/nkmCRnXbWm).
96119

97-
# ✍️ Licence
120+
## ✍️ Licence
98121

99122
> This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/jvondermarck/dinosaur-exploder/blob/main/LICENSE) file for details.
100123
101-
# 👨 Author
124+
## 👨 Author
102125

103-
<p align="center"> At first we are a group of three creators (Dylan, Maxime and I), but since 2023, I am taking care of everything.
126+
- Initially, the project was a collaboration between three creators : Dylan, Maxime, and myself—as part of a school project at the University of Cork in 2022. However, after the semester ended, I took over full responsibility for the project, while my teammates moved on to other endeavors."
104127

105128
<table align="center">
106129
<tr>

0 commit comments

Comments
 (0)