README.md in ngt-0.3.3 vs README.md in ngt-0.4.0
- old
+ new
@@ -1,17 +1,17 @@
-# NGT
+# NGT Ruby
[NGT](https://github.com/yahoojapan/NGT) - high-speed approximate nearest neighbors - for Ruby
-[](https://github.com/ankane/ngt/actions)
+[](https://github.com/ankane/ngt-ruby/actions)
## Installation
Add this line to your application’s Gemfile:
```ruby
-gem 'ngt'
+gem "ngt"
```
On Mac, also install OpenMP:
```sh
@@ -153,14 +153,14 @@
```ruby
[[1, 2, 3], [4, 5, 6]]
```
-Or a Numo NArray
+Or a Numo array
```ruby
-Numo::DFloat.new(3, 2).seq
+Numo::NArray.cast([[1, 2, 3], [4, 5, 6]])
```
## Resources
- [ANN Benchmarks](https://github.com/erikbern/ann-benchmarks)
@@ -169,25 +169,25 @@
This library is modeled after NGT’s [Python API](https://github.com/yahoojapan/NGT/blob/master/python/README-ngtpy.md).
## History
-View the [changelog](https://github.com/ankane/ngt/blob/master/CHANGELOG.md)
+View the [changelog](https://github.com/ankane/ngt-ruby/blob/master/CHANGELOG.md)
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
-- [Report bugs](https://github.com/ankane/ngt/issues)
-- Fix bugs and [submit pull requests](https://github.com/ankane/ngt/pulls)
+- [Report bugs](https://github.com/ankane/ngt-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/ngt-ruby/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
To get started with development:
```sh
-git clone https://github.com/ankane/ngt.git
-cd ngt
+git clone https://github.com/ankane/ngt-ruby.git
+cd ngt-ruby
bundle install
bundle exec rake vendor:all
bundle exec rake test
```