README.md in fasttext-0.1.0 vs README.md in fasttext-0.1.1
- old
+ new
@@ -1,17 +1,26 @@
# fastText
[fastText](https://fasttext.cc) - efficient text classification and representation learning - for Ruby
+[](https://travis-ci.org/ankane/fasttext)
+
## Installation
Add this line to your application’s Gemfile:
```ruby
gem 'fasttext'
```
+## Getting Started
+
+fastText has two primary use cases:
+
+- [text classification](#text-classification)
+- [word representations](#word-representations)
+
## Text Classification
Prep your data
```ruby
@@ -229,11 +238,11 @@
model.predict("bon appétit")
```
## rbenv
-This library uses [Rice](https://github.com/jasonroelofs/rice) to interface with the fastText C++ library. Unfortunately, Rice and rbenv don’t play nicely together. This is actively [being addressed](https://github.com/rbenv/ruby-build/pull/1368), but in the meantime, if you encounter an error during installation, reinstall your Ruby version with the `--enabled-shared` flag.
+This library uses [Rice](https://github.com/jasonroelofs/rice) to interface with the fastText C++ library. Unfortunately, Rice and rbenv don’t play nicely together. This is actively [being addressed](https://github.com/rbenv/ruby-build/pull/1368), but in the meantime, if you encounter an error during installation, reinstall your Ruby version with the `--enable-shared` flag.
```sh
CONFIGURE_OPTS="--enable-shared" rbenv install 2.6.5
```
@@ -247,5 +256,15 @@
- [Report bugs](https://github.com/ankane/fasttext/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/fasttext/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/fasttext.git
+cd fasttext
+bundle install
+rake compile
+rake test
+```