Skip to content

Commit f5edb54

Browse files
committed
Fix readme. Fix links to docs.
1 parent 56c2c3c commit f5edb54

2 files changed

Lines changed: 6 additions & 18 deletions

File tree

README.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,15 @@ Generate Ruby bindings from C and C++ headers.
55
## Install
66

77
```console
8-
git clone https://github.com/ruby-rice/ruby-bindgen.git
9-
cd ruby-bindgen
10-
rake install
8+
gem install ruby-bindgen
119
```
1210

1311
## Run
1412

1513
```bash
16-
mkdir -p /path/to/output
17-
ruby-bindgen /path/to/config.yaml
14+
ruby-bindgen config.yaml
1815
```
1916

20-
`output` must already exist and be a directory.
17+
## Documentation
2118

22-
## Docs
23-
24-
- [Documentation Index](docs/index.md)
25-
- [Configuration](docs/configuration.md)
26-
- [C++ Bindings (Rice)](docs/cpp_bindings.md)
27-
- [C Bindings (FFI)](docs/c_bindings.md)
28-
- [CMake Bindings](docs/cmake_bindings.md)
29-
- [Prior Art](docs/prior_art.md)
30-
- [Troubleshooting](docs/troubleshooting.md)
31-
- [Contributing](docs/contributing.md)
19+
Documentation is at [ruby-rice.github.io/ruby-bindgen](https://ruby-rice.github.io/ruby-bindgen/).

zensical.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ site_name = "ruby-bindgen"
44
site_description = "Generate Ruby bindings from C and C++ header files"
55
site_url = "https://ruby-rice.github.io/ruby-bindgen/"
66

7-
repo_name = "ruby-bindgen/ruby-bindgen"
8-
repo_url = "https://github.com/ruby-bindgen/ruby-bindgen"
7+
repo_name = "ruby-rice/ruby-bindgen"
8+
repo_url = "https://github.com/ruby-rice/ruby-bindgen"
99

1010
nav = [
1111
{ "Home" = "index.md" },

0 commit comments

Comments
 (0)