Skip to content

Commit

Permalink
1.0.0. Using a plugin to create an executable file (#3).
Browse files Browse the repository at this point in the history
  • Loading branch information
Vladislav Kuznetsov committed Jul 12, 2021
1 parent b1e089e commit 073d1ec
Show file tree
Hide file tree
Showing 7 changed files with 291 additions and 71 deletions.
Binary file added assets/languages/english.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/languages/russian.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/vertex-form-popup-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/vertex-form.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
61 changes: 57 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,79 @@
<!--suppress HtmlDeprecatedAttribute -->
<div align="center">
<h1>
<a href="https://funprojectsforsoul.github.io/Vertex/">Project Vertex</a>
<a href="https://funprojectsforsoul.github.io/Vertex/">Vertex</a>
</h1>
</div>

<div align="center">
<a href="https://github.com/FunProjectsForSoul/Vertex/blob/master/docs/translations/README_RU.md">
<img alt="russian-version" src="https://raw.githubusercontent.com/FunProjectsForSoul/Vertex/master/assets/languages/russian.png"/>
</a>
</div>

<div align="center">
<img src="https://img.shields.io/github/last-commit/FunProjectsForSoul/Vertex" height="25" alt="last-commit" />
<img src="https://img.shields.io/github/v/release/FunProjectsForSoul/Vertex" height="25" alt="last-release" />
<img src="https://tokei.rs/b1/github/FunProjectsForSoul/Vertex?category=code" height="25" alt="code-lines" />
<img src="https://sonarcloud.io/api/project_badges/measure?project=FunProjectsForSoul_Vertex&metric=bugs" height="25" alt="sonar-cloud-bugs" />
<img src="https://github.com/FunProjectsForSoul/Vertex/actions/workflows/check-style.yml/badge.svg" height="25" alt="checking-style" />
<img src="https://github.com/FunProjectsForSoul/Vertex/actions/workflows/sonar.yml/badge.svg" height="25" alt="checking-sonar" />
<img src="https://github.com/FunProjectsForSoul/Vertex/actions/workflows/build.yml/badge.svg" height="25" alt="build" />
</div>

### Description
### 📖 Description
___

Desktop application for random updating of the displayed number from 0 to 100. It is possible to start updating the
number by timer at intervals: 1 second or 1.5 seconds.

### License
### ❗ Requirements
___

* **JDK**: 8 and higher;
* **Configured environment variable**: JAVA_HOME.

### 📋 Instructions for starting the project
___

*All commands are executed in the console.*
1. Create a folder: `mkdir GitProjects`;
2. Go to the folder: `cd GitProjects`;
3. Cloning a repository: `git clone https://github.com/FunProjectsForSoul/Vertex.git`;
4. Go to the folder: `cd Vertex`;
5. Build project: `mvn clean install`;
6. After completing 5 points — a folder with the name **“Target”** will be created. We go into it: `go target`;
7. Inside there will be a JAR file named **“vertex-0.2.2.jar”**.
We execute the command: `java -jar vertex-0.2.2.jar`;
8. The GUI application will start **(see: Application interface)**.

**Bonus**: instead of point 7, you can act differently.
In the folder — **target**, there will also be a file: **vertex.exe**, which you can simply run.
If you have any problems — write to me.

```java
public class VertexApplication {

public static void main(String[] args) { // Used to launch the application.
Runnable runnable = VertexUtil::started;
invokeLater(runnable);
}
}
```

### 💻 Application interface
___
<div align="center">
<img src="https://raw.githubusercontent.com/FunProjectsForSoul/Vertex/master/assets/vertex-form.gif" alt="gui-interface" />
</div>

<div align="center">
<img src="https://raw.githubusercontent.com/FunProjectsForSoul/Vertex/master/assets/vertex-form-popup-menu.png" alt="gui-interface" />
</div>

### 🎫 License
___

**[Creative Commons Legal Code](https://github.com/Bangerok/Vertex/blob/master/LICENSE)**

_Copyright ©2021, Vladislav (Bangerok) Kuznetsov_
_Copyright ©2021, Vladislav [[Bangerok]](https://github.com/Bangerok) Kuznetsov_
79 changes: 79 additions & 0 deletions docs/translations/README_RU.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<!--suppress HtmlDeprecatedAttribute -->
<div align="center">
<h1>
<a href="https://funprojectsforsoul.github.io/Vertex/">Vertex</a>
</h1>
</div>

<div align="center">
<a href="https://github.com/FunProjectsForSoul/Vertex/blob/master/docs/README.md">
<img alt="english-version" src="https://raw.githubusercontent.com/FunProjectsForSoul/Vertex/master/assets/languages/english.png"/>
</a>
</div>

<div align="center">
<img src="https://img.shields.io/github/last-commit/FunProjectsForSoul/Vertex" height="25" alt="last-commit" />
<img src="https://img.shields.io/github/v/release/FunProjectsForSoul/Vertex" height="25" alt="last-release" />
<img src="https://tokei.rs/b1/github/FunProjectsForSoul/Vertex?category=code" height="25" alt="code-lines" />
<img src="https://sonarcloud.io/api/project_badges/measure?project=FunProjectsForSoul_Vertex&metric=bugs" height="25" alt="sonar-cloud-bugs" />
<img src="https://github.com/FunProjectsForSoul/Vertex/actions/workflows/check-style.yml/badge.svg" height="25" alt="checking-style" />
<img src="https://github.com/FunProjectsForSoul/Vertex/actions/workflows/sonar.yml/badge.svg" height="25" alt="checking-sonar" />
<img src="https://github.com/FunProjectsForSoul/Vertex/actions/workflows/build.yml/badge.svg" height="25" alt="build" />
</div>

### 📖 Описание
___

Настольное приложение для случайного обновления отображаемого числа от 0 до 100. Можно обновлять число по таймеру с
интервалом: 1 секунда или 1,5 секунды.

### ❗ Требования
___

* **JDK**: 8 или выше;
* **Сконфигурированная переменная окружения**: JAVA_HOME.

### 📋 Инструкция по запуску проекта
___

*Все команды выполняются в консоли.*
1. Создать папку: `mkdir GitProjects`;
2. Перейти в нее: `cd GitProjects`;
3. Клонировать код репозитория: `git clone https://github.com/FunProjectsForSoul/Vertex.git`;
4. Перейти в созданную папку: `cd Vertex`;
5. Собрать проект: `mvn clean install`;
6. После выполнения 5 пункта — будет создана папка с именем **“target”**. Переходим в нее: `go target`;
7. Внутри будет находиться файл **“vertex-0.2.2.jar”**.
Запускаем его командой: `java -jar vertex-0.2.2.jar`;
8. Запустится приложение.

**Бонус**: вместо 7 пункта можно действовать иначе.
В папке — **target**, также есть файл: **vertex.exe**, который можно просто запустить.
Если возникнут проблемы — пиши мне.

```java
public class VertexApplication {

public static void main(String[] args) { // Используетс для запуска приложения.
Runnable runnable = VertexUtil::started;
invokeLater(runnable);
}
}
```

### 💻 Интерфейс приложения
___
<div align="center">
<img src="https://raw.githubusercontent.com/FunProjectsForSoul/Vertex/master/assets/vertex-form.gif" alt="gui-interface" />
</div>

<div align="center">
<img src="https://raw.githubusercontent.com/FunProjectsForSoul/Vertex/master/assets/vertex-form-popup-menu.png" alt="gui-interface" />
</div>

### 🎫 Лицензия
___

**[Creative Commons Legal Code](https://github.com/Bangerok/Vertex/blob/master/LICENSE)**

_Copyright ©2021, Vladislav [[Bangerok]](https://github.com/Bangerok) Kuznetsov_
Loading

0 comments on commit 073d1ec

Please sign in to comment.