Skip to content

Commit 1d7dcd4

Browse files
authored
docs: refactor APGv2 structure to match docs style
1 parent 8cc38a8 commit 1d7dcd4

1 file changed

Lines changed: 34 additions & 8 deletions

File tree

docs/apg/standart/apgv2/struktura-paketa.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Структура пакета APGv2
22

3-
APG (Advanced Package) — формат пакетов для NurOS. Пакет представляет собой tar-архив с дополнительным сжатием (например, `.tar.xz`, `.tar.zst`).
3+
APG (APG Package) — формат пакетов для NurOS. Пакет представляет собой tar-архив с дополнительным сжатием (например, `.tar.xz`, `.tar.zst`).
44

55
## Структура архива
66

@@ -33,7 +33,7 @@ package.apg
3333
| `scripts/` | Скрипты pre/post install/remove | Нет |
3434
| `home/` | Файлы, устанавливаемые в домашний каталог `$HOME` | Нет |
3535

36-
## Подробнее о компонентах
36+
## Описание компонентов
3737

3838
### metadata.json
3939

@@ -44,26 +44,41 @@ package.apg
4444
Текстовый файл с контрольными суммами всех файлов пакета. Пакет должен содержать **один** из этих файлов.
4545

4646
**Формат md5sums:**
47+
4748
```
4849
d41d8cd98f00b204e9800998ecf8427e data/usr/bin/example
4950
e99a18c428cb38d5f260853678922e03 data/etc/example.conf
5051
```
5152

5253
**Формат crc32sums:**
54+
5355
```
5456
a1b2c3d4 data/usr/bin/example
5557
e5f6a7b8 data/etc/example.conf
5658
```
5759

58-
:::info Выбор алгоритма
60+
**Выбор алгоритма:**
61+
5962
- **MD5**: Более надежная проверка целостности, стандарт для большинства пакетов
6063
- **CRC32**: Быстрая проверка, подходит для больших пакетов где важна скорость
61-
:::
6264

6365
### data/
6466

6567
Каталог с файлами, которые будут распакованы в корень системы `/`. Структура внутри `data/` повторяет структуру файловой системы.
6668

69+
**Пример:**
70+
71+
```
72+
data/
73+
├── usr/
74+
│ ├── bin/
75+
│ │ └── myapp
76+
│ └── share/
77+
│ └── myapp/
78+
└── etc/
79+
└── myapp.conf
80+
```
81+
6782
### scripts/
6883

6984
Каталог со скриптами, выполняемыми при установке/удалении:
@@ -75,14 +90,25 @@ e5f6a7b8 data/etc/example.conf
7590
| `pre-remove` | Перед удалением файлов |
7691
| `post-remove` | После удаления файлов |
7792

93+
Все скрипты должны быть исполняемыми (`chmod +x`) и использовать shebang (`#!/bin/bash`).
94+
7895
### home/
7996

8097
Каталог с файлами для домашнего каталога пользователя. Работает аналогично `data/`, но относительно `$HOME`.
8198

82-
:::tip Совет
99+
**Пример:**
100+
101+
```
102+
home/
103+
└── .config/
104+
└── myapp/
105+
└── config.ini
106+
```
107+
108+
:::info Информация
83109
Используйте `home/` для конфигурационных файлов пользователя, таких как `.bashrc`, `.config/` и т.д.
84110
:::
85111

86-
## Дополнительная информация
87-
88-
Полная спецификация формата APG доступна в репозитории [apg-docs](https://github.com/NurOS-Linux/apg-docs).
112+
:::warning Внимание
113+
Убедитесь, что выбран только один файл контрольных сумм: `md5sums` или `crc32sums`. Наличие обоих файлов может привести к ошибкам при установке пакета.
114+
:::

0 commit comments

Comments
 (0)