zhangyiss/toml11
1
0
Fork 0
mirror of https://github.com/ToruNiina/toml11.git synced 2025-09-15 15:38:17 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: update versions in docs

Browse Source
This commit is contained in:
ToruNiina
2025-02-16 00:14:52 +09:00
parent 587f9acb2a
commit be08ba2be2
10 changed files with 136 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -126,7 +126,7 @@ include(FetchContent)
FetchContent_Declare(
toml11
GIT_REPOSITORY https://github.com/ToruNiina/toml11.git
GIT_TAG v4.3.0
GIT_TAG v4.4.0
)
FetchContent_MakeAvailable(toml11)
@@ -141,15 +141,17 @@ After [adding cpm to your project](https://github.com/cpm-cmake/CPM.cmake?tab=re
```cmake
include(cmake/CPM.cmake)
CPMAddPackage("gh:ToruNiina/toml11@4.3.0")
CPMAddPackage("gh:ToruNiina/toml11@4.4.0")
# OR
CPMAddPackage(
NAME toml11
GITHUB_REPOSITORY "ToruNiina/toml11"
VERSION 4.3.0
OPTIONS "TOML11_PRECOMPILE ON" # to pre-compile
VERSION 4.4.0
OPTIONS
"TOML11_PRECOMPILE ON" # to pre-compile
"TOML11_ENABLE_ACCESS_CHECK ON" # to use value.accessed()
)
add_executable(main main.cpp)

10
README_ja.md
View File

@@ -127,7 +127,7 @@ include(FetchContent)
FetchContent_Declare(
toml11
GIT_REPOSITORY https://github.com/ToruNiina/toml11.git
GIT_TAG v4.3.0
GIT_TAG v4.4.0
)
FetchContent_MakeAvailable(toml11)
@@ -142,15 +142,17 @@ target_link_libraries(main PRIVATE toml11::toml11)
```cmake
include(cmake/CPM.cmake)
CPMAddPackage("gh:ToruNiina/toml11@4.3.0")
CPMAddPackage("gh:ToruNiina/toml11@4.4.0")
# OR
CPMAddPackage(
NAME toml11
GITHUB_REPOSITORY "ToruNiina/toml11"
VERSION 4.3.0
OPTIONS "TOML11_PRECOMPILE ON" # to pre-compile
VERSION 4.4.0
OPTIONS
"TOML11_PRECOMPILE ON" # to pre-compile
"TOML11_ENABLE_ACCESS_CHECK ON" # to use value.accessed()
)
add_executable(main main.cpp)

19
docs/content.en/docs/changelog/_index.md
View File

@@ -6,6 +6,25 @@ weight = 4
# Change Log
# v4.4.0
## Added
- Add `toml::find_or_default()` (#280) (by Ken Matsui @ken-matsui)
- Add `erase` to `ordered_map` (#282) (#283) (by Sunlight @SunPodder)
- Add `bool basic_value::accessed() const` to detect whether the value has been accessed
- enabled only if `TOML11_ENABLE_ACCESS_CHECK` is defined
- Add compare operators to `toml::spec`
## Fixed
- Use `is_void<T>` instead of `is_same<T, void>` (#281) (by Ken Matsui @ken-matsui)
## Changed
- Improve `toml::parse` performance by 2x
- Stop using deprecated Ubuntu 20 image on GitHub Actions
# v4.3.0
## Added

2
docs/content.en/docs/features/toml_spec.md
View File

@@ -38,7 +38,7 @@ If not specified explicitly, `toml::spec::default_version()` is used to construc
The default value depends on the version of toml11 and follows the latest version of the TOML language released at that time.
As of v4.0.0, TOML v1.1.0 has not been released yet, so the default TOML version is v1.0.0.
As of v4.4.0, TOML v1.1.0 has not been released yet, so the default TOML version is v1.0.0.
{{<hint warning>}}

41
docs/content.en/docs/installation/_index.md
View File

@@ -27,6 +27,47 @@ target_link_libraries(main PUBLIC toml11::toml11)
toml11 will only run tests and install when it is the root project.
### CMake `FetchContent`
Using `FetchContent`, you can automatically download toml11 to your `build` directory.
```cmake
include(FetchContent)
FetchContent_Declare(
toml11
GIT_REPOSITORY https://github.com/ToruNiina/toml11.git
GIT_TAG v4.4.0
)
FetchContent_MakeAvailable(toml11)
add_executable(main main.cpp)
target_link_libraries(main PRIVATE toml11::toml11)
```
### CMake Package Manager (CPM)
After [adding cpm to your project](https://github.com/cpm-cmake/CPM.cmake?tab=readme-ov-file#adding-cpm), you can use toml11 by doing:
```cmake
include(cmake/CPM.cmake)
CPMAddPackage("gh:ToruNiina/toml11@4.4.0")
# OR
CPMAddPackage(
NAME toml11
GITHUB_REPOSITORY "ToruNiina/toml11"
VERSION 4.4.0
OPTIONS
"TOML11_PRECOMPILE ON" # to pre-compile
"TOML11_ENABLE_ACCESS_CHECK ON" # to use value.accessed()
)
add_executable(main main.cpp)
target_link_libraries(main PUBLIC toml11::toml11)
```
## Installing using cmake
After cloning toml11, you can install it using cmake.

2
docs/content.en/docs/reference/spec.md
View File

@@ -131,7 +131,7 @@ Constructs a `spec` with the default version.
Used as the default value for `toml::parse` and `toml::format`.
In toml11 v4.0.0, the value is v1.0.0.
In toml11 v4.4.0, the value is v1.0.0.
### `v(major, minor, patch)`

19
docs/content.ja/docs/changelog/_index.md
View File

@@ -6,6 +6,25 @@ weight = 4
# Change Log
# v4.4.0
## Added
- `toml::find_or_default()` を追加 (by Ken Matsui @ken-matsui)
- `ordered_map`から値を削除できるよう変更 (by Sunlight @SunPodder)
- 値がアクセス済みかを調べる`bool basic_value::accessed() const`を追加
- `TOML11_ENABLE_ACCESS_CHECK`が定義されているときのみ有効
- `toml::spec`に比較演算子を追加
## Fixed
- `is_same<T, void>`ではなく`is_void`を使用するように修正 (by Ken Matsui @ken-matsui)
## Changed
- `toml::parse`のパフォーマンスを約2倍向上
- GitHub ActionsでUbuntu 20のイメージの使用を終了
# v4.3.0
## Added

2
docs/content.ja/docs/features/toml_spec.md
View File

@@ -42,7 +42,7 @@ int main()
デフォルトの値はtoml11のバージョンによって変わりますが、その時点でリリースされているTOML言語の最新バージョンに追従します。
v4.0.0現在、TOML v1.1.0はまだリリースされていないため、デフォルトのTOMLバージョンはv1.0.0です。
v4.4.0現在、TOML v1.1.0はまだリリースされていないため、デフォルトのTOMLバージョンはv1.0.0です。
{{<hint warning>}}

41
docs/content.ja/docs/installation/_index.md
View File

@@ -27,6 +27,47 @@ target_link_libraries(main PUBLIC toml11::toml11)
`toml11`は自身がルートプロジェクトのときのみ、テストとインストールを行います。
### CMake `FetchContent`
CMakeの `FetchContent`を使用することで、`build`ディレクトリに自動でダウンロードすることができます。
```cmake
include(FetchContent)
FetchContent_Declare(
toml11
GIT_REPOSITORY https://github.com/ToruNiina/toml11.git
GIT_TAG v4.4.0
)
FetchContent_MakeAvailable(toml11)
add_executable(main main.cpp)
target_link_libraries(main PRIVATE toml11::toml11)
```
### CMake Package Manager (CPM)
[CMake package manager](https://github.com/cpm-cmake/CPM.cmake)を導入すると、以下のようにして使用することができます。
```cmake
include(cmake/CPM.cmake)
CPMAddPackage("gh:ToruNiina/toml11@4.4.0")
# OR
CPMAddPackage(
NAME toml11
GITHUB_REPOSITORY "ToruNiina/toml11"
VERSION 4.4.0
OPTIONS
"TOML11_PRECOMPILE ON" # to pre-compile
"TOML11_ENABLE_ACCESS_CHECK ON" # to use value.accessed()
)
add_executable(main main.cpp)
target_link_libraries(main PUBLIC toml11::toml11)
```
## `cmake`を使用してインストールする
`toml11`をクローンしたのち、`cmake`を使ってインストールすることができます。

2
docs/content.ja/docs/reference/spec.md
View File

@@ -131,7 +131,7 @@ constexpr static spec default_version() noexcept;
`toml::parse`、`toml::format`でのデフォルト値として使われます。
toml11 v4.0.0での値は、v1.0.0です。
toml11 v4.4.0での値は、v1.0.0です。
### `v(major, minor, patch)`