diff --git a/Documentation/lib:compressor.lua.md b/Documentation/lib:compressor.lua.md new file mode 100644 index 00000000..d6708bf4 --- /dev/null +++ b/Documentation/lib:compressor.lua.md @@ -0,0 +1,18 @@ + + +compressor.**pack**( *string* pathToCompressedFile, ... ) +--------------------------------------------------------- +> Данный метод позволяет объединить множество входных файлов и директорий в один файл-пакет без сжатия и потери данных. + +| Тип | Аргумент | Описание | +| ------ | ------ | ------ | +| *string* | pathToCompressedFile | Путь, по которому результирующий пакет должен быть сохранен | +| *string* | ... | Множество путей к файлам или директориям, которые должны быть упакованы в пакет | +compressor.**unpack**( *string* pathToCompressedFile, *string* pathWhereToUnpack ) +------------------------------------------------------------------------ +> Метод, позволяющий распаковать содержимое пакета, созданного методом .**pack()**, в указанную директорию. + +| Тип | Аргумент | Описание | +| ------ | ------ | ------ | +| *string* | pathToCompressedFile | Путь к имеющемуся пакету | +| *string* | pathWhereToUnpack | Путь к папке, в которую должна быть произведена распаковка | \ No newline at end of file diff --git a/Documentation/lib:compressor.md b/Documentation/lib:compressor.md deleted file mode 100644 index a329bdc4..00000000 --- a/Documentation/lib:compressor.md +++ /dev/null @@ -1,35 +0,0 @@ -*Функция compressor.pack(pathToCompressedFile, ...)*: - - Эта функция позволяет сжать данные и поместить их в сжатом виде в архив. -**Аргументы функции**: - - pathToCompressedFile: Путь к архиву, в который нужно поместить сжатые данные. - - ... : многоточием тут является перечень объектов, указанных через запятую. Каждый объект - является путем до папки, файлы в которой надо сжать.Ниже следует пример: - - compressor.pack("/test1.pkg", "/MineOS/System/OS/", "/etc/") - -*Функция compressor.unpack(pathToCompressedFile, pathWhereToUnpack)*: - - Эта функция позволяет прочитать архив со сжатыми данными и распаковать их в указанную папку. - -**Аргументы функции**: - - pathToCompressedFile: Путь к архиву, который нужно распаковать. - - pathWhereToUnpack: Путь к папке, куда нужно распаковать.Ниже следует пример: - - compressor.unpack("/test1.pkg", "/papkaUnpacked/") - -*Функция compressor.unpack(pathToCompressedFile, pathWhereToUnpack)*: - - Эта функция позволяет прочитать архив со сжатыми данными и распаковать их в указанную папку. - -**Аргументы функции**: - - pathToCompressedFile: Путь к архиву, который нужно распаковать. - - pathWhereToUnpack: Путь к папке, куда нужно распаковать.Ниже следует пример: - - compressor.unpack("/test1.pkg", "/papkaUnpacked/") diff --git a/Documentation/lib:image.md b/Documentation/lib:image.lua.md similarity index 100% rename from Documentation/lib:image.md rename to Documentation/lib:image.lua.md