1
0
mirror of https://github.com/fumiama/base16384.git synced 2026-06-13 00:00:23 +08:00

doc(all): sync to the latest status

This commit is contained in:
源文雨
2025-09-04 01:06:47 +08:00
parent 26467a463e
commit 81898adfb7
15 changed files with 44 additions and 20 deletions

View File

@@ -2,10 +2,10 @@ cmake_minimum_required(VERSION 2.8.12...4.1.1)
if (POLICY CMP0048) if (POLICY CMP0048)
cmake_policy(SET CMP0048 NEW) cmake_policy(SET CMP0048 NEW)
endif (POLICY CMP0048) endif (POLICY CMP0048)
project(base16384 VERSION 2.3.1) project(base16384 VERSION 2.3.2)
add_definitions(-DBASE16384_VERSION="${PROJECT_VERSION}") add_definitions(-DBASE16384_VERSION="${PROJECT_VERSION}")
add_definitions(-DBASE16384_VERSION_DATE="April 7th 2024") add_definitions(-DBASE16384_VERSION_DATE="Sep 4th 2025")
message(STATUS "Testing endian...") message(STATUS "Testing endian...")
include(TestBigEndian) include(TestBigEndian)

View File

@@ -32,8 +32,8 @@ Save more space and since the code 0x0000 is encoded to "一", finding zero spac
sudo apt install base16384 sudo apt install base16384
``` ```
### Install from Homebrew ### Install from Homebrew (MacOS, etc.)
> 从 Homebrew 安装 > 从 Homebrew 安装 (如 MacOS 等系统)
```bash ```bash
brew install base16384 brew install base16384
``` ```
@@ -46,6 +46,18 @@ sudo apt-get update
sudo apt-get install base16384 sudo apt-get install base16384
``` ```
### Install from OpenWrt packages
> OpenWrt 下安装 packages
```bash
opkg install base16384
```
### Install from Arch Linux AUR
> Arch Linux 上从 AUR 仓库安装
```
yay -S base16384
```
### Build from source code ### Build from source code
> 编译 > 编译
@@ -86,6 +98,18 @@ base16384 -[ed][t][n][cC] [inputfile] [outputfile]
outputfile pass - to write to stdout outputfile pass - to write to stdout
``` ```
You can also run functional tests by
也可执行以下命令以测试功能
```bash
mkdir build
cd build
cmake -DBUILD=test ..
cmake --build . --config Release --target all --
ctest
```
## Examples ## Examples
> 用例 > 用例
1. Encode simple text 1. Encode simple text
@@ -96,7 +120,7 @@ base16384 -[ed][t][n][cC] [inputfile] [outputfile]
婌焳廔萷 婌焳廔萷
``` ```
3. Decode simple text 2. Decode simple text
> 简单文本解码 > 简单文本解码
```bash ```bash

View File

@@ -1,6 +1,6 @@
/* base1432.c /* base1432.c
* This file is part of the base16384 distribution (https://github.com/fumiama/base16384). * This file is part of the base16384 distribution (https://github.com/fumiama/base16384).
* Copyright (c) 2022-2024 Fumiama Minamoto. * Copyright (c) 2022-2025 Fumiama Minamoto.
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by

View File

@@ -1,6 +1,6 @@
/* base1464.c /* base1464.c
* This file is part of the base16384 distribution (https://github.com/fumiama/base16384). * This file is part of the base16384 distribution (https://github.com/fumiama/base16384).
* Copyright (c) 2022-2024 Fumiama Minamoto. * Copyright (c) 2022-2025 Fumiama Minamoto.
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by

View File

@@ -1,4 +1,4 @@
.TH BASE16384 1 "7 April 2024" "GNU" "User Commands" .TH BASE16384 1 "4 Sep 2025" "GNU" "User Commands"
.SH NAME .SH NAME
base16384 \- Encode binary files to printable utf16be base16384 \- Encode binary files to printable utf16be
.SH SYNOPSIS .SH SYNOPSIS
@@ -104,7 +104,7 @@ on github.
.SH AUTHOR .SH AUTHOR
This manual page contributed by Fumiama Minamoto. This manual page contributed by Fumiama Minamoto.
.SH "COPYRIGHT" .SH "COPYRIGHT"
Copyright \(co 2022-2024, Fumiama Minamoto Copyright \(co 2022-2025, Fumiama Minamoto
This file is part of This file is part of
.IR "base16384" . .IR "base16384" .
.LP .LP

View File

@@ -1,6 +1,6 @@
/* base16384.c /* base16384.c
* This file is part of the base16384 distribution (https://github.com/fumiama/base16384). * This file is part of the base16384 distribution (https://github.com/fumiama/base16384).
* Copyright (c) 2022-2024 Fumiama Minamoto. * Copyright (c) 2022-2025 Fumiama Minamoto.
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
@@ -46,7 +46,7 @@ static base16384_err_t print_usage() {
#define BASE16384_VERSION_DATE "unknown date" #define BASE16384_VERSION_DATE "unknown date"
#endif #endif
fputs( fputs(
"Copyright (c) 2022-2024 Fumiama Minamoto.\nBase16384 " "Copyright (c) 2022-2025 Fumiama Minamoto.\nBase16384 "
BASE16384_VERSION BASE16384_VERSION
" (" " ("
BASE16384_VERSION_DATE BASE16384_VERSION_DATE

View File

@@ -3,7 +3,7 @@
/* base16384.h /* base16384.h
* This file is part of the base16384 distribution (https://github.com/fumiama/base16384). * This file is part of the base16384 distribution (https://github.com/fumiama/base16384).
* Copyright (c) 2022-2024 Fumiama Minamoto. * Copyright (c) 2022-2025 Fumiama Minamoto.
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by

View File

@@ -3,7 +3,7 @@
/* binary.h /* binary.h
* This file is part of the base16384 distribution (https://github.com/fumiama/base16384). * This file is part of the base16384 distribution (https://github.com/fumiama/base16384).
* Copyright (c) 2022-2024 Fumiama Minamoto. * Copyright (c) 2022-2025 Fumiama Minamoto.
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by

2
file.c
View File

@@ -1,6 +1,6 @@
/* file.c /* file.c
* This file is part of the base16384 distribution (https://github.com/fumiama/base16384). * This file is part of the base16384 distribution (https://github.com/fumiama/base16384).
* Copyright (c) 2022-2024 Fumiama Minamoto. * Copyright (c) 2022-2025 Fumiama Minamoto.
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by

View File

@@ -1,4 +1,4 @@
cmake_minimum_required(VERSION 2.8.12) cmake_minimum_required(VERSION 2.8.12...4.1.1)
if (POLICY CMP0048) if (POLICY CMP0048)
cmake_policy(SET CMP0048 NEW) cmake_policy(SET CMP0048 NEW)
endif (POLICY CMP0048) endif (POLICY CMP0048)

View File

@@ -1,6 +1,6 @@
/* test/coder_test.c /* test/coder_test.c
* This file is part of the base16384 distribution (https://github.com/fumiama/base16384). * This file is part of the base16384 distribution (https://github.com/fumiama/base16384).
* Copyright (c) 2022-2024 Fumiama Minamoto. * Copyright (c) 2022-2025 Fumiama Minamoto.
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by

View File

@@ -1,6 +1,6 @@
/* test/file_test.c /* test/file_test.c
* This file is part of the base16384 distribution (https://github.com/fumiama/base16384). * This file is part of the base16384 distribution (https://github.com/fumiama/base16384).
* Copyright (c) 2022-2024 Fumiama Minamoto. * Copyright (c) 2022-2025 Fumiama Minamoto.
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by

View File

@@ -3,7 +3,7 @@
/* test/file_test.h /* test/file_test.h
* This file is part of the base16384 distribution (https://github.com/fumiama/base16384). * This file is part of the base16384 distribution (https://github.com/fumiama/base16384).
* Copyright (c) 2022-2024 Fumiama Minamoto. * Copyright (c) 2022-2025 Fumiama Minamoto.
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by

View File

@@ -1,6 +1,6 @@
/* test/wrap_test.c /* test/wrap_test.c
* This file is part of the base16384 distribution (https://github.com/fumiama/base16384). * This file is part of the base16384 distribution (https://github.com/fumiama/base16384).
* Copyright (c) 2022-2024 Fumiama Minamoto. * Copyright (c) 2022-2025 Fumiama Minamoto.
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by

2
wrap.c
View File

@@ -1,6 +1,6 @@
/* wrap.c /* wrap.c
* This file is part of the base16384 distribution (https://github.com/fumiama/base16384). * This file is part of the base16384 distribution (https://github.com/fumiama/base16384).
* Copyright (c) 2022-2024 Fumiama Minamoto. * Copyright (c) 2022-2025 Fumiama Minamoto.
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by