Skip to content

Commit

Permalink
docs: refine build instructions and bump version in NEWS
Browse files Browse the repository at this point in the history
  • Loading branch information
kanru committed Jan 18, 2024
1 parent 4788576 commit 568548e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 25 deletions.
2 changes: 1 addition & 1 deletion NEWS
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
What's New in libchewing 0.6.0-rc.1 (UNRELEASED)
What's New in libchewing 0.6.0-rc.2 (UNRELEASED)
---------------------------------------------------------

This release contains many improvements and bug fixes. It's the first
Expand Down
34 changes: 10 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,19 +105,18 @@ be built.
+ Build tools:
- cmake >= 3.21.0
+ Toolchain / IDE:
- clang >= 3.2
- gcc >= 4.6.3
- clang >= 3.2 OR gcc >= 4.6.3
- Rust >= 1.70
- Visual Studio Express 2012
- Visual Studio Express 2012 for MSVC build
+ Documentation tools:
- texinfo >= 4.12
- texinfo >= 4.8


## Installation
## Build and Installation

cmake --preset c99-release
cmake --build out/build/c99-release
cmake --install out/build/c99-release --prefix /usr
cmake --preset default --install-prefix /usr
cmake --build --preset default
cmake --build --preset default -t install

For macOS:

Expand All @@ -131,8 +130,8 @@ Define a [cmake-toolchains][] file to cross-compile.

Example cross-build instructions:

cmake --preset c99-release --toolchain arm-none-linux-gnueabi.cmake
cmake --build out/build/c99-release
cmake --preset default --toolchain arm-none-linux-gnueabi.cmake
cmake --build --preset default

[cmake-toolchains]: https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html

Expand Down Expand Up @@ -166,20 +165,7 @@ commands to install the tools you need:

brew install cmake
brew install rustup
brew install texinfo


### cmake

Because macOS uses an older version of `makeinfo`, you have to set MAKEINFO
manually to where Homebrew installed makeinfo. For example:

# cmake -DMAKEINFO=/usr/local/Cellar/texinfo/5.2/bin/makeinfo .

then

# make

rustup default stable

## Usage

Expand Down

0 comments on commit 568548e

Please sign in to comment.