From a05159082650867267b60dcdc2c0023551ab5555 Mon Sep 17 00:00:00 2001 From: Alexander Popov Date: Sun, 25 Jun 2023 21:25:18 +0300 Subject: [PATCH] update readme --- .gitignore | 6 +- Makefile | 6 +- README.md | 79 +++---------------- README.ru.md | 35 ++++++++ make-libs-list.c => make-libs-string.c | 0 ...s-list.vcxproj => make-libs-string.vcxproj | 0 6 files changed, 53 insertions(+), 73 deletions(-) create mode 100644 README.ru.md rename make-libs-list.c => make-libs-string.c (100%) rename make-libs-list.vcxproj => make-libs-string.vcxproj (100%) diff --git a/.gitignore b/.gitignore index 7984e4d..a82eb9a 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,5 @@ -make-libs-list +make-libs-string + +# export data +*.json +*.txt diff --git a/Makefile b/Makefile index 2a01fa4..3e0e856 100644 --- a/Makefile +++ b/Makefile @@ -2,10 +2,10 @@ CC = clang CFLAGS = -O2 LIBS = -lcjson -all: make-libs-list +all: make-libs-string -make-libs-list: +make-libs-string: $(CC) $(CFLAGS) make-libs-list.c $(LIBS) -o $@ clean: - rm make-libs-list + rm make-libs-string diff --git a/README.md b/README.md index 2e964ff..50ccf7e 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,11 @@ -# Parse `version.json` file and return libs +# Parse `version.json` file and return libraries list -## English +[Russian](README.ru.md) | +[English](README.md). **About:** -Utility parse Minecraft JE game version file (`version.json`) and returns -libraries list for specified operation system. - -**How to build from source:** - -**Linux:** -```sh -conan install . -make -``` - -**Windows:** -```sh -conan install . -conan build . -``` +Utility for parse Minecraft JE game version file (`version.json`). **How to use:** @@ -39,58 +25,13 @@ Utility has two required arguments, `` and ``. * `version.json` - takes the path to the file. -* `system` - takes one of three values `w` `l` `x`, the letter of which corresponds to one of the operating systems. +* `system` - takes one of three values `w, l, x`, the letter of which corresponds to one of the operating systems. -_**version.json**_ example for 1.19.2 version. +**Example for +wget https://piston-meta.mojang.com/v1/packages/715ccf3330885e75b205124f09f8712542cbe7e0/1.20.1.json +[1.20.1]() +version:** ```sh -wget https://piston-meta.mojang.com/v1/packages/68cded4616fba9fbefb3f895033c261126c5f89c/1.19.2.json -``` - - -## Русский - -**Описание:** - -Утилита парсит файл версий (`version.json`) Minecraft JE и возвращает -список библиотек для указанной операционной системы. - -**Как скомпилировать:** - -**Linux:** -```sh -conan install . -make -``` - -**Windows:** -```sh -conan install . -conan build . -``` - -**Как использовать:** - -``` -Minecraft Libraries List Generator - -Usage: - make-libs-string - - - w|l|x (windows or linux or osx) - -Other: - make-libs-string i - to get version info -``` - -Программа имеет два обязательных аргумента, -`` и ``. - -* `version.json` - принимает путь к файлу -* `system` - принимает одно из трёх значений `w` `l` `x`, буква которых соответствует одной из операционных систем. - -Пример _**version.json**_ для версии 1.19.2. - -```sh -wget https://piston-meta.mojang.com/v1/packages/68cded4616fba9fbefb3f895033c261126c5f89c/1.19.2.json +./make-libs-string ./1.20.1.json x ``` diff --git a/README.ru.md b/README.ru.md new file mode 100644 index 0000000..1182115 --- /dev/null +++ b/README.ru.md @@ -0,0 +1,35 @@ +# Парсит файла `version.json` и вовражает список библиотек + +[English](README.md) | +[Russian](README.ru.md). + +**Описание:** + +Утилита для парсинга файлов версий Minecraft JE (`version.json`). + +**Как использовать:** + +``` +Minecraft Libraries List Generator + +Usage: + make-libs-string + + - w|l|x (windows or linux or osx) + +Other: + make-libs-string i - to get version info +``` + +Программа имеет два обязательных аргумента, +`` и ``. + +* `version.json` - принимает путь к файлу +* `system` - принимает одно из трёх значений `w, l, x`, буква которых соответствует одной из операционных систем. + +**Пример для версии +[1.20.1](https://piston-meta.mojang.com/v1/packages/715ccf3330885e75b205124f09f8712542cbe7e0/1.20.1.json)**: + +```sh +./make-libs-string ./1.20.1.json x +``` diff --git a/make-libs-list.c b/make-libs-string.c similarity index 100% rename from make-libs-list.c rename to make-libs-string.c diff --git a/make-libs-list.vcxproj b/make-libs-string.vcxproj similarity index 100% rename from make-libs-list.vcxproj rename to make-libs-string.vcxproj