Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BeichenY1 committed Mar 9, 2024
1 parent d444645 commit 3c278d0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 23 deletions.
5 changes: 3 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ version = "0.9.0"
edition = "2021"
authors = ["Zewei Yang <[email protected]>"]
description = "A Cargo-like build tool for building C and C++ applications"
license = "Apache-2.0"
homepage = "https://github.com/syswonder/ruxgo"
repository = "https://github.com/syswonder/ruxgo"
documentation = "https://syswonder.github.io/ruxgo/"
keywords = ["toml", "build-tool", "c++", "c", "rust"]
documentation = "https://ruxgo.syswonder.org/"
keywords = ["toml", "build-tool", "rust", "c++", "c"]

[dependencies]
toml = "0.7.2"
Expand Down
24 changes: 3 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,20 @@

Ruxgo is a Cargo-like build tool for building C and C++ applications that relies solely on a Toml file.

**To start using Ruxgo**, learn more at [The Ruxgo Book](https://syswonder.github.io/ruxgo/).
**To start using Ruxgo**, learn more at [The Ruxgo Book](https://ruxgo.syswonder.org/).

🚧 Working In Progress.

## Installation

To build the `ruxgo` executable from source, you will first need to install Rust and Cargo. Follow the instructions on the [Rust installation page](https://www.rust-lang.org/tools/install). Ruxgo currently requires at least Rust version 1.70.
To build the `ruxgo` executable from source, you will first need to install Rust and Cargo. Follow the instructions on the [Rust installation page](https://www.rust-lang.org/tools/install). Ruxgo currently requires at least Rust version 1.74.

Once you have installed Rust, the following command can be used to build and install Ruxgo:

```sh
cargo install --git https://github.com/syswonder/ruxgo.git ruxgo
```

This will automatically download Ruxgo, build it, and install it in Cargo's global binary directory (`~/.cargo/bin/` by default).

To uninstall, run the command `cargo uninstall ruxgo`.

**Note:**

If you have problems with the installation, you may need to install some build dependencies, refer to [README.md](https://github.com/syswonder/ruxos?tab=readme-ov-file#install-build-dependencies) under RuxOS.

## Features & TODOs

* [x] Multithreaded and incremental builds
* [x] Supports static libs and dynamic libs
* [x] Support for building on RuxOS
* [x] Supported ruxlibc and ruxmusl
* [x] Can generate compile_commands.json
* [x] Package management
* [ ] Automatically parses Makefiles

## Usage

Write a `config_linux.toml` for linux and `config_win32.toml` for windows in the project directory.
Expand Down Expand Up @@ -73,4 +55,4 @@ The `ruxgo/apps/` directory places all the Toml files that have been tested, you
* [x] httpclient
* [x] httpserver
* [x] nginx
* [ ] python3
* [x] python3

0 comments on commit 3c278d0

Please sign in to comment.