Skip to content

Commit af552f6

Browse files
committed
Merge branch 'develop' of github.com:khorevaa/1cli into develop
2 parents 9ae0c09 + 428c49d commit af552f6

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Build Status](https://travis-ci.org/khorevaa/1cli.svg?branch=master)](https://travis-ci.org/khorevaa/1cli)
44
[![Coverage Status](https://coveralls.io/repos/github/khorevaa/1cli/badge.svg?branch=master)](https://coveralls.io/github/khorevaa/1cli?branch=master)
55

6-
Данная библиотека для языка Oscript, позволяет создавать консольные приложения с разбором и проверкой аргументов.
6+
Данная библиотека для языка OScript, позволяет создавать консольные приложения с разбором и проверкой аргументов.
77

88
## Быстрый старт
99

@@ -100,7 +100,7 @@
100100

101101
Для установки необходимо:
102102
* Скачать файл 1cli.ospx из раздела [releases](https://github.com/khorevaa/1cli/releases)
103-
* воспользоваться команды:
103+
* Воспользоваться командой:
104104

105105
```
106106
$ opm install -f <ПутьКФайлу>
@@ -114,7 +114,7 @@ $ opm install -f <ПутьКФайлу>
114114
Приложение = Новый КонсольноеПриложение("1cli", "Помощник генерации приложения на основании шаблона 1cli");
115115
```
116116

117-
Для установки основной функции выполнения приложения необходимо создать класс или модуль должен реализовывать экспортную процедуру:
117+
Для установки основной функции выполнения приложения необходимо создать класс, или сам модуль должен реализовать экспортную процедуру:
118118
```bsl
119119
Процедура ВыполнитьКоманду(Знач Команда) Экспорт
120120
КонецПроцедуры
@@ -152,7 +152,7 @@ $ opm install -f <ПутьКФайлу>
152152
* Дата
153153
* Длительность
154154

155-
Так и принимать массивы данных типов, на пример:
155+
Также опция может принимать массивы данных типов, на пример:
156156

157157
* МассивЧисел
158158
* МассивСтрок
@@ -210,7 +210,7 @@ $ opm install -f <ПутьКФайлу>
210210
* Дата
211211
* Длительность
212212

213-
Так и принимать массивы данных типов, на пример:
213+
Также аргументы могут принимать массивы данных типов, например:
214214

215215
* МассивЧисел
216216
* МассивСтрок
@@ -243,14 +243,14 @@ $ opm install -f <ПутьКФайлу>
243243
ИмяФайла = Команда.Аргумент("FILE", "", "имя файла для создания")
244244
```
245245

246-
Если нужное нам имя файла равно `-f` и выполнить нашу команду:
246+
Допустим, нужное нам имя файла равно `-f`, тогда если выполнить нашу команду:
247247

248248
```
249249
ХочуФайл -f
250250
```
251251

252-
Будет выдана ошибка, т.к. `-f` распознано как опция, а не аргумент.
253-
Для того, чтобы решить данную проблему, необходимо объявить окончание опций, через оператора `--`
252+
то будет выдана ошибка, т.к. `-f` распознано как опция, а не аргумент.
253+
Для того, чтобы решить данную проблему, необходимо объявить окончание опций через оператор `--`
254254

255255
```
256256
ХочуФайл -- -f
@@ -279,7 +279,7 @@ $ opm install -f <ПутьКФайлу>
279279
КомандаAve = Приложение.ДобавитьПодкоманду("start run r", "Команда start", КлассРеализацииПодкоманды);
280280
```
281281

282-
Псевдонимы для команды будут `start`, `run`, и`r` можно использовать любой из них.
282+
Псевдонимы для команды будут `start`, `run`, и`r` - можно использовать любой из них.
283283

284284
1cli поддерживает автоматическую инициализацию параметров команд.
285285
Переданный класс должен реализовывать процедуру:
@@ -343,7 +343,7 @@ $ opm install -f <ПутьКФайлу>
343343

344344
### Выбор между
345345

346-
Для отражения выборка между несколькими опциями или аргументами используется символ `|`:
346+
Для отражения выбора между несколькими опциями или аргументами используется символ `|`:
347347

348348
```bsl
349349
Команда.Спек = "--server | --agent";
@@ -362,19 +362,19 @@ $ opm install -f <ПутьКФайлу>
362362

363363
### Логические группы
364364

365-
Возможна логическая группировка опций и аргументов. Данную группировки стоит использовать и комбинировать с такими символами как `|` и `...`:
365+
Возможна логическая группировка опций и аргументов. Данную группировку стоит использовать и комбинировать с такими символами как `|` и `...`:
366366

367367
```bsl
368368
Команда.Спек = "(-e КОМАНДА)... | (-x|-y)";
369369
```
370-
Данный пример, настраивает строку использования следующим образом:
370+
Приведенный пример настраивает строку использования следующим образом:
371371
* Повторение опции -e и команды
372372
* Или
373373
* Выбор между -x и -y
374374

375375
### Группировка опций
376376

377-
Все короткие опции (типа булево), возможно группировать в любом порядке вместе:
377+
Все короткие опции (типа булево) можно группировать в любом порядке вместе:
378378
```bsl
379379
Команда.Спек = "-abcd";
380380
```
@@ -461,7 +461,7 @@ $ opm install -f <ПутьКФайлу>
461461

462462
## Доработка
463463

464-
Доработка проводиться по git-flow. Жду ваших PR.
464+
Доработка проводится по git-flow. Жду ваших PR.
465465

466466
## Лицензия
467467

0 commit comments

Comments
 (0)