Skip to content

Commit 1f4c196

Browse files
DCFApixelsDCFApixels
committed
update readme
1 parent d6c4608 commit 1f4c196

File tree

2 files changed

+92
-6
lines changed

2 files changed

+92
-6
lines changed

‎README-RU.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<p align="center">
2+
<img src="https://github.com/DCFApixels/Notes-Unity/assets/99481254/d6e83712-be0b-4d74-9fce-b78872f32434" >
3+
</p>
4+
5+
<p align="center">
6+
<img alt="Version" src="https://img.shields.io/github/package-json/v/DCFApixels/Notes-Unity?color=%23FFC200&style=for-the-badge">
7+
<img alt="License" src="https://img.shields.io/github/license/DCFApixels/Notes-Unity?color=FFC200&style=for-the-badge">
8+
</p>
9+
10+
# Заметки для Редактора Unity
11+
12+
<table>
13+
<tr></tr>
14+
<tr>
15+
<td colspan="3">Readme Languages:</td>
16+
</tr>
17+
<tr></tr>
18+
<tr>
19+
<td nowrap width="100">
20+
<a href="https://github.com/DCFApixels/Notes-Unity/blob/main/README-RU.md">
21+
<img src="https://github.com/user-attachments/assets/3c699094-f8e6-471d-a7c1-6d2e9530e721"></br>
22+
<span>Русский</span>
23+
</a>
24+
</td>
25+
<td nowrap width="100">
26+
<a href="https://github.com/DCFApixels/Notes-Unity">
27+
<img src="https://github.com/user-attachments/assets/30528cb5-f38e-49f0-b23e-d001844ae930"></br>
28+
<span>English</span>
29+
</a>
30+
</td>
31+
</tr>
32+
</table>
33+
34+
<br>
35+
36+
37+
<p align="center">
38+
<img src="https://github.com/DCFApixels/Notes-Unity/assets/99481254/e8e3e6a9-9d35-48db-b786-45554fa3e08e" width="600" >
39+
<br>
40+
Заметки в Scene View для дизайнеров.
41+
</p>
42+
43+
## Установка
44+
Семантика версионирования - [Открыть](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#file-dcfapixels_versioning_ru-md)
45+
46+
* ### Unity-модуль
47+
Добавьте git-URL в [PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) или вручную в `Packages/manifest.json` файл. Используйте этот git-URL:
48+
```
49+
https://github.com/DCFApixels/Notes-Unity.git
50+
```
51+
* ### В виде исходников
52+
Можно установит просто скопировав исходники в папку проекта
53+
54+
<br>
55+
56+
## Как использовать
57+
Просто добавьте компонент `Note` или `LazyNote` на любой GameObject. Либо используйте ПКМ + "GameObject/Notes/Create Note"(или LazyNote) для автоматического создания объекта с заметкой.
58+
59+
Чтобы добавить пресеты Авторов или Типов Заметок нажмите на иконку ![gear](https://github.com/DCFApixels/Notes-Unity/assets/99481254/0d0efe29-6f54-44d1-a8a6-90f895e101ee) в компоненте заметки.
60+
61+
Чтобы отобразить текст заметки в Scene View, используйте разделитель ">-<", весь текст перед разделителем будет отображен.
62+
63+
Заметки предназначены для использования только в редакторе, все данные из заметок будут удалены в Release сборке.

‎README.md‎

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,38 @@
88
</p>
99

1010
# Notes for Unity Editor
11-
Notes on Scene View for designers.
11+
12+
<table>
13+
<tr></tr>
14+
<tr>
15+
<td colspan="3">Readme Languages:</td>
16+
</tr>
17+
<tr></tr>
18+
<tr>
19+
<td nowrap width="100">
20+
<a href="https://github.com/DCFApixels/Notes-Unity/blob/main/README-RU.md">
21+
<img src="https://github.com/user-attachments/assets/7bc29394-46d6-44a3-bace-0a3bae65d755"></br>
22+
<span>Русский</span>
23+
</a>
24+
</td>
25+
<td nowrap width="100">
26+
<a href="https://github.com/DCFApixels/Notes-Unity">
27+
<img src="https://github.com/user-attachments/assets/3c699094-f8e6-471d-a7c1-6d2e9530e721"></br>
28+
<span>English</span>
29+
</a>
30+
</td>
31+
</tr>
32+
</table>
33+
34+
1235
<p align="center">
1336
<img src="https://github.com/DCFApixels/Notes-Unity/assets/99481254/e8e3e6a9-9d35-48db-b786-45554fa3e08e" width="600" >
37+
<br>
38+
Notes on Scene View for designers.
1439
</p>
1540

1641
## Installation
17-
42+
Versioning semantics - [Open](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#file-dcfapixels_versioning_ru-md)
1843
* ### Unity-module
1944
Add the git-URL to the project [using PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) or directly to the `Packages/manifest.json` file. Copy this git-URL:
2045
```
@@ -23,12 +48,10 @@ https://github.com/DCFApixels/Notes-Unity.git
2348
* ### Using source code
2449
Can install by copying the sources into the project.
2550

26-
### Versioning
27-
Versioning semantics: [Open](https://gist.github.com/DCFApixels/c3b178a308b411f530361d1d56f1f929#versioning)
28-
51+
<br>
2952

3053
## How to use
31-
Just add the "Note" or "LazyNote" component to any object. Or use RMB + "GameObject/Notes/Create Note"(or LazyNote) to automatically create a note object.
54+
Just add the `Note` or `LazyNote` component to any GameObject. Or use RMB + "GameObject/Notes/Create Note"(or LazyNote) to automatically create a note object.
3255

3356
To add Author or Note Type presets, click on the ![gear](https://github.com/DCFApixels/Notes-Unity/assets/99481254/0d0efe29-6f54-44d1-a8a6-90f895e101ee) icon in the Note component.
3457

0 commit comments

Comments
 (0)