Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update documentation
  • Loading branch information
fdabrandao committed Jun 28, 2016
1 parent 067a112 commit bf64df4
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 39 deletions.
12 changes: 11 additions & 1 deletion CHANGELOG.md
Expand Up @@ -2,6 +2,15 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [3.1.2] - 2016-06-28

### Changed
- Simplified the .afg format.

### Fixed
- Fixed crash on Windows x64.


## [3.1.1] - 2016-05-12

### Changed
Expand Down Expand Up @@ -76,7 +85,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
### Added
- First official release of the C++ implementation of VPSolver.

[Unreleased]: https://github.com/fdabrandao/vpsolver/compare/v3.1.1...H
[Unreleased]: https://github.com/fdabrandao/vpsolver/compare/v3.1.2...H
[3.1.2]: https://github.com/fdabrandao/vpsolver/compare/v3.1.1...v3.1.2
[3.1.1]: https://github.com/fdabrandao/vpsolver/compare/v3.1.0...v3.1.1
[3.1.0]: https://github.com/fdabrandao/vpsolver/compare/v3.0.1...v3.1.0
[3.0.1]: https://github.com/fdabrandao/vpsolver/compare/v3.0.0...v3.0.1
Expand Down
14 changes: 2 additions & 12 deletions README.md
Expand Up @@ -34,7 +34,7 @@ For more details, please refer to the [project wiki](https://github.com/fdabrand

#### Optional

For the [Python API](https://github.com/fdabrandao/vpsolver/wiki/Python-API) and [Web App](#vpsolver-web-app):
For the [Python API](https://github.com/fdabrandao/vpsolver/wiki/Python-API) and Web App:

* `python-2.7` or `python-3.x`
* `python-pip`
Expand Down Expand Up @@ -71,7 +71,6 @@ Or simply install from the [repository](https://pypi.python.org/pypi/pyvpsolver)
```
$ pip install pyvpsolver
```
Note: use `pip install pyvpsolver --pre` if you want to install the latest pre-release.

## Python interface

Expand Down Expand Up @@ -133,15 +132,6 @@ URL: http://172.17.0.60:5555/

For more details, please refer to the [project wiki](https://github.com/fdabrandao/vpsolver/wiki/docker).

## VPSolver Web App
VPSolver includes a Web App that can be started as follows:

```
$ python -m pyvpsolver.webapp.app
```

The Web App can then be accessed on a web browser at `http://127.0.0.1:5555/`.

## VPSolver binaries

* `$ bin/vpsolver intance.vbp/.mvp`: solves a multiple-choice vector packing instance using the method described in [\[1\]](#references). Note: requires Gurobi 5.0.0 or superior;
Expand Down Expand Up @@ -232,4 +222,4 @@ http://www.dcc.fc.up.pt/~fdabrandao/research/vpsolver/results/


***
Copyright © 2013-2016 [Filipe Brandão](http://www.dcc.fc.up.pt/~fdabrandao/) <[fdabrandao@dcc.fc.up.pt](mailto:fdabrandao@dcc.fc.up.pt)>. All rights reserved.
Copyright © 2013-2016 [Filipe Brandão](http://www.dcc.fc.up.pt/~fdabrandao/) < [fdabrandao@dcc.fc.up.pt](mailto:fdabrandao@dcc.fc.up.pt) >. All rights reserved.
31 changes: 24 additions & 7 deletions docs/html/CHANGELOG.html
Expand Up @@ -55,18 +55,35 @@ <h1>
This project adheres to <a href="http://semver.org/">Semantic Versioning</a>.</p>

<h2>
<a id="user-content-311---2016-05-12" class="anchor" href="#311---2016-05-12" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a><a href="https://github.com/fdabrandao/vpsolver/compare/v3.1.0...v3.1.1">3.1.1</a> - 2016-05-12</h2>
<a id="user-content-312---2016-06-28" class="anchor" href="#312---2016-06-28" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a><a href="https://github.com/fdabrandao/vpsolver/compare/v3.1.1...v3.1.2">3.1.2</a> - 2016-06-28</h2>

<h3>
<a id="user-content-changed" class="anchor" href="#changed" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Changed</h3>

<ul>
<li>Simplified the Python API.</li>
<li>Simplified the .afg format.</li>
</ul>

<h3>
<a id="user-content-fixed" class="anchor" href="#fixed" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Fixed</h3>

<ul>
<li>Fixed crash on Windows x64.</li>
</ul>

<h2>
<a id="user-content-311---2016-05-12" class="anchor" href="#311---2016-05-12" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a><a href="https://github.com/fdabrandao/vpsolver/compare/v3.1.0...v3.1.1">3.1.1</a> - 2016-05-12</h2>

<h3>
<a id="user-content-changed-1" class="anchor" href="#changed-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Changed</h3>

<ul>
<li>Simplified the Python API.</li>
</ul>

<h3>
<a id="user-content-fixed-1" class="anchor" href="#fixed-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Fixed</h3>

<ul>
<li>Fixed <code>afg2svg</code>.</li>
</ul>
Expand All @@ -82,7 +99,7 @@ <h3>
</ul>

<h3>
<a id="user-content-changed-1" class="anchor" href="#changed-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Changed</h3>
<a id="user-content-changed-2" class="anchor" href="#changed-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Changed</h3>

<ul>
<li>The syntax used in the .vbp and .afg files for additional parameters.</li>
Expand All @@ -92,7 +109,7 @@ <h2>
<a id="user-content-301---2016-02-23" class="anchor" href="#301---2016-02-23" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a><a href="https://github.com/fdabrandao/vpsolver/compare/v3.0.0...v3.0.1">3.0.1</a> - 2016-02-23</h2>

<h3>
<a id="user-content-fixed-1" class="anchor" href="#fixed-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Fixed</h3>
<a id="user-content-fixed-2" class="anchor" href="#fixed-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Fixed</h3>

<ul>
<li>Fixed a minor compatibility issue with Python 2.7.</li>
Expand All @@ -109,7 +126,7 @@ <h3>
</ul>

<h3>
<a id="user-content-changed-2" class="anchor" href="#changed-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Changed</h3>
<a id="user-content-changed-3" class="anchor" href="#changed-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Changed</h3>

<ul>
<li>Replaced the GPLv3+ license by AGPLv3+.</li>
Expand All @@ -123,7 +140,7 @@ <h3>
</ul>

<h3>
<a id="user-content-fixed-2" class="anchor" href="#fixed-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Fixed</h3>
<a id="user-content-fixed-3" class="anchor" href="#fixed-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Fixed</h3>

<ul>
<li>Various bugfixes.</li>
Expand All @@ -148,7 +165,7 @@ <h3>
</ul>

<h3>
<a id="user-content-fixed-3" class="anchor" href="#fixed-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Fixed</h3>
<a id="user-content-fixed-4" class="anchor" href="#fixed-4" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Fixed</h3>

<ul>
<li>Various bugfixes.</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/Docker.html
Expand Up @@ -120,7 +120,7 @@ <h3>

<hr>

<p>Copyright © 2013-2016 <a href="http://www.dcc.fc.up.pt/%7Efdabrandao/">Filipe Brandão</a> &lt;<a href="mailto:fdabrandao@dcc.fc.up.pt">fdabrandao@dcc.fc.up.pt</a>&gt;. All rights reserved.</p>
<p>Copyright © 2013-2016 <a href="http://www.dcc.fc.up.pt/%7Efdabrandao/">Filipe Brandão</a> &lt; <a href="mailto:fdabrandao@dcc.fc.up.pt">fdabrandao@dcc.fc.up.pt</a> &gt;. All rights reserved.</p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/Home.html
Expand Up @@ -79,7 +79,7 @@ <h3>

<hr>

<p>Copyright © 2013-2016 <a href="http://www.dcc.fc.up.pt/%7Efdabrandao/">Filipe Brandão</a> &lt;<a href="mailto:fdabrandao@dcc.fc.up.pt">fdabrandao@dcc.fc.up.pt</a>&gt;. All rights reserved.</p>
<p>Copyright © 2013-2016 <a href="http://www.dcc.fc.up.pt/%7Efdabrandao/">Filipe Brandão</a> &lt; <a href="mailto:fdabrandao@dcc.fc.up.pt">fdabrandao@dcc.fc.up.pt</a> &gt;. All rights reserved.</p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/PyMPL.html
Expand Up @@ -69,7 +69,7 @@ <h3>

<hr>

<p>Copyright © 2013-2016 <a href="http://www.dcc.fc.up.pt/%7Efdabrandao/">Filipe Brandão</a> &lt;<a href="mailto:fdabrandao@dcc.fc.up.pt">fdabrandao@dcc.fc.up.pt</a>&gt;. All rights reserved.</p>
<p>Copyright © 2013-2016 <a href="http://www.dcc.fc.up.pt/%7Efdabrandao/">Filipe Brandão</a> &lt; <a href="mailto:fdabrandao@dcc.fc.up.pt">fdabrandao@dcc.fc.up.pt</a> &gt;. All rights reserved.</p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/Python-API.html
Expand Up @@ -566,7 +566,7 @@ <h3>

<hr>

<p>Copyright © 2013-2016 <a href="http://www.dcc.fc.up.pt/%7Efdabrandao/">Filipe Brandão</a> &lt;<a href="mailto:fdabrandao@dcc.fc.up.pt">fdabrandao@dcc.fc.up.pt</a>&gt;. All rights reserved.</p>
<p>Copyright © 2013-2016 <a href="http://www.dcc.fc.up.pt/%7Efdabrandao/">Filipe Brandão</a> &lt; <a href="mailto:fdabrandao@dcc.fc.up.pt">fdabrandao@dcc.fc.up.pt</a> &gt;. All rights reserved.</p>

</div>
</div>
Expand Down
16 changes: 2 additions & 14 deletions docs/html/README.html
Expand Up @@ -105,7 +105,7 @@ <h4>
<h4>
<a id="user-content-optional" class="anchor" href="#optional" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Optional</h4>

<p>For the <a href="Python-API.html">Python API</a> and <a href="#vpsolver-web-app">Web App</a>:</p>
<p>For the <a href="Python-API.html">Python API</a> and Web App:</p>

<ul>
<li>
Expand Down Expand Up @@ -152,8 +152,6 @@ <h2>
<pre><code>$ pip install pyvpsolver
</code></pre>

<p>Note: use <code>pip install pyvpsolver --pre</code> if you want to install the latest pre-release.</p>

<h2>
<a id="user-content-python-interface" class="anchor" href="#python-interface" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Python interface</h2>

Expand Down Expand Up @@ -213,16 +211,6 @@ <h3>

<p>For more details, please refer to the <a href="https://github.com/fdabrandao/vpsolver/wiki/docker">project wiki</a>.</p>

<h2>
<a id="user-content-vpsolver-web-app" class="anchor" href="#vpsolver-web-app" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>VPSolver Web App</h2>

<p>VPSolver includes a Web App that can be started as follows:</p>

<pre><code>$ python -m pyvpsolver.webapp.app
</code></pre>

<p>The Web App can then be accessed on a web browser at <code>http://127.0.0.1:5555/</code>.</p>

<h2>
<a id="user-content-vpsolver-binaries" class="anchor" href="#vpsolver-binaries" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>VPSolver binaries</h2>

Expand Down Expand Up @@ -341,7 +329,7 @@ <h2>

<hr>

<p>Copyright © 2013-2016 <a href="http://www.dcc.fc.up.pt/%7Efdabrandao/">Filipe Brandão</a> &lt;<a href="mailto:fdabrandao@dcc.fc.up.pt">fdabrandao@dcc.fc.up.pt</a>&gt;. All rights reserved.</p>
<p>Copyright © 2013-2016 <a href="http://www.dcc.fc.up.pt/%7Efdabrandao/">Filipe Brandão</a> &lt; <a href="mailto:fdabrandao@dcc.fc.up.pt">fdabrandao@dcc.fc.up.pt</a> &gt;. All rights reserved.</p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki
Submodule wiki updated from 9ec3ec to 19968d

0 comments on commit bf64df4

Please sign in to comment.