README.md in scs-0.2.0 vs README.md in scs-0.2.1
- old
+ new
@@ -2,18 +2,22 @@
[SCS](https://github.com/cvxgrp/scs) - the splitting conic solver - for Ruby
:fire: Supports many different [problem types](https://www.cvxpy.org/tutorial/advanced/index.html#choosing-a-solver)
+[![Build Status](https://travis-ci.org/ankane/scs.svg?branch=master)](https://travis-ci.org/ankane/scs) [![Build status](https://ci.appveyor.com/api/projects/status/wyn0cbgs0k5vg5tq/branch/master?svg=true)](https://ci.appveyor.com/project/ankane/scs/branch/master)
+
## Installation
Add this line to your application’s Gemfile:
```ruby
gem 'scs'
```
+If installation fails, you may need to install [dependencies](#dependencies).
+
## Getting Started
Prep the problem
```ruby
@@ -23,11 +27,11 @@
And solve it
```ruby
solver = SCS::Solver.new
-result = solver.solve(data, cone)
+solver.solve(data, cone)
```
## Settings
Default values shown
@@ -54,10 +58,20 @@
```ruby
SCS::Solver.new(indirect: true)
```
+## Dependencies
+
+BLAS and LAPACK are required for SCS.
+
+```sh
+sudo apt-get install libblas-dev liblapack-dev
+```
+
+On Heroku, use the [heroku-apt-buildpack](https://github.com/heroku/heroku-buildpack-apt).
+
## Resources
- [Conic Optimization via Operator Splitting and Homogeneous Self-Dual Embedding](https://web.stanford.edu/~boyd/papers/scs.html)
## History
@@ -71,13 +85,13 @@
- [Report bugs](https://github.com/ankane/scs/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/scs/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
-To get started with development and testing:
+To get started with development:
```sh
-git clone https://github.com/ankane/scs.git
+git clone --recursive https://github.com/ankane/scs.git
cd scs
bundle install
bundle exec rake compile
bundle exec rake test
```