Skip to content

Commit 41cbf8d

Browse files
committed
Adds requirements section
Signed-off-by: Manoel Campos <[email protected]>
1 parent 4a55218 commit 41cbf8d

File tree

1 file changed

+28
-7
lines changed

1 file changed

+28
-7
lines changed

README.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# CloudSim Plus Examples [![Build Status](https://github.com/cloudsimplus/cloudsimplus-examples/actions/workflows/maven.yml/badge.svg)](https://github.com/cloudsimplus/cloudsimplus-examples/actions/workflows/maven.yml)
22
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/cloudsimplus/cloudsimplus-examples)
33

4-
54
This module contains several [CloudSim Plus](https://github.com/cloudsimplus/cloudsimplus) examples,
65
including those inherited from CloudSim and new ones for exclusive features.
76
Those later ones are available into the [org.cloudsimplus.examples](src/main/java/org/cloudsimplus/examples) package.
@@ -14,7 +13,13 @@ The example places all the required code inside the `main()` method just for con
1413
However, that code is not reusable. If you try to build simulations that way, you'll end up with a messy and duplicated code.
1514
Therefore, after you understood how to build basic simulations, you may want to try checking the [BasicFirstExample.java](src/main/java/org/cloudsimplus/examples/BasicFirstExample.java). It's a structured and reusable code that gives a picture of the best ways to write your simulations.
1615

17-
## 1. Downloading the project
16+
## 1. Project Requirements
17+
18+
CloudSim Plus Examples is a Java 17 project that uses maven for build and dependency management. To build and run the project, you need JDK 17+ installed and an updated version of maven (such as 3.8.6+). Maven is already installed on your IDE. Unless it's out-of-date or you want to build the project from the command line, you need to install maven into your operating system.
19+
20+
All project dependencies are download automatically by maven (including CloudSim Plus jars).
21+
22+
## 2. Downloading the Project Sources
1823

1924
You can download this project using (i) the download button on top of this page (ii) your own IDE for it or (iii) the command line as described below.
2025

@@ -27,14 +32,30 @@ download the project source by cloning the repository issuing the following comm
2732
git clone https://github.com/cloudsimplus/cloudsimplus-examples.git
2833
```
2934

30-
## 2 Running Examples
35+
# 3. Building the Examples
36+
37+
CloudSim Plus Examples is a maven project, therefore to build it, you have two ways:
38+
39+
## 3.1 Using some IDE
40+
41+
Open the project on your favorite IDE and click the build button and that is it.
42+
43+
## 3.1 Using a terminal
44+
45+
First, make sure you have an updated Maven version installed (such as 3.8.6+), open a terminal at the project root directory and type:
46+
47+
```bash
48+
mvn clean install
49+
mvn dependency:resolve -Dclassifier=javadoc
50+
```
51+
52+
The second command is optional but very useful to download CloudSim Plus JavaDocs and help you understand the API inside your IDE.
3153

32-
> **Warning**
33-
> Before trying to use this project, make sure you have JDK 17 installed.
54+
## 4. Running Examples
3455

3556
There are 2 ways to run the examples in this project, as presented below.
3657

37-
### By Means of an IDE
58+
### 4.1 Using some IDE
3859

3960
The easiest way to run the examples is relying on some IDE.
4061
Below are required steps:
@@ -48,7 +69,7 @@ Below are required steps:
4869
You can run any one of the classes in this package to get a specific example.
4970
- If you want to build your own simulations, the easiest way is to create another class inside this project.
5071

51-
### Using the bootstrap.sh script
72+
### 4.2 Using the bootstrap.sh script
5273

5374
The project has a [bootstrap.sh](bootstrap.sh) script you can use to build and run CloudSim Plus examples.
5475
This is a script for Unix-like systems such as Linux, FreeBSD and macOS.

0 commit comments

Comments
 (0)