update readme

This commit is contained in:
Alexander Popov 2023-06-25 21:25:18 +03:00
parent 2461420f15
commit a051590826
Signed by: iiiypuk
GPG Key ID: E47FE0AB36CD5ED6
6 changed files with 53 additions and 73 deletions

6
.gitignore vendored
View File

@ -1 +1,5 @@
make-libs-list
make-libs-string
# export data
*.json
*.txt

View File

@ -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

View File

@ -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,
`<version.json>` and `<system>`.
* `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 <version.json> <system>
<system> - w|l|x (windows or linux or osx)
Other:
make-libs-string <version.json> i - to get version info
```
Программа имеет два обязательных аргумента,
`<version.json>` и `<system>`.
* `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
```

35
README.ru.md Normal file
View File

@ -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 <version.json> <system>
<system> - w|l|x (windows or linux or osx)
Other:
make-libs-string <version.json> i - to get version info
```
Программа имеет два обязательных аргумента,
`<version.json>` и `<system>`.
* `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
```