Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade of the README page #1109

Merged
merged 5 commits into from
Jan 12, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 14 additions & 17 deletions ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
## New Features / Critical Changes

- *Configuration/General*
- DGtal requires now to have a C++11 enabled compiler (gcc>4.6, clang
>2.9, VS14, ...). This allows us to use new C++11 features in
- DGtal requires now to have a C++11 enabled compiler (gcc>4.6,
clang>2.9, VS14, ...). This allows us to use new C++11 features in
DGtal core and to have more generic and reliable code. (David
Coeurjolly, [#1080](https://github.com/DGtal-team/DGtal/pull/1080))

- DGtal core now compiles on Microsoft Windows, Visual Studio (only
VS14 or above). Many issues have been fixed for compatibility with
'cl' compiler. (David Coeurjolly, Jérémy Levallois,
Expand Down Expand Up @@ -79,30 +79,24 @@
Coeurjolly, [#1074](https://github.com/DGtal-team/DGtal/pull/1074))

- *IO*

- By default, closing a Viewer3D does not save automatically the viewer
state anymore (in a .qglviewer.xml file). The automatic save can be
activated by a flag (myAutoSaveState). (Bertrand Kerautret
[#1088](https://github.com/DGtal-team/DGtal/pull/1088))

- In the Viewer3D, the light source position is now saved in the
QGLViewer state file (.qglviewer.xml). (Bertrand Kerautret
[#1087](https://github.com/DGtal-team/DGtal/pull/1087))

- Minor improvements of default settings in Viewer3D. (David
Coeurjolly, [#1066](https://github.com/DGtal-team/DGtal/pull/1066))

- change the chronological order to diplay primitives (in the draw
function) in order to see the cube primitive through the
transparency of the ball primitives. (Bertrand Kerautret,
[#1081](https://github.com/DGtal-team/DGtal/pull/1081))

- New possibility to move the light source direction using the mouse move
in Viewer3D (with the key SHIFT+CTRL (SHIFT+CMD on mac)). The light source
direction is now defined according the main coordinate system (no more from
the camera center).
(Bertrand Kerautret [#1070](https://github.com/DGtal-team/DGtal/pull/1070))

- Adding raw I/O capabilities for non integral types and signed integers.
(Roland Denis [#1084](https://github.com/DGtal-team/DGtal/pull/1084))

Expand Down Expand Up @@ -133,10 +127,13 @@
- Fix for swapped coordinates in TangentFromDSS2DFunctor. (Kacper
Pluta,
[#1083](https://github.com/DGtal-team/DGtal/issues/1083))

- Update of the README.md page. (David Coeurjolly,
[#1109](https://github.com/DGtal-team/DGtal/issues/1109))

- *Base Package*
- Fix wrong initialization of reverse iterators in SimpleRandomAccess(Const)RangeFromPoint.
(Roland Denis, [#1060](https://github.com/DGtal-team/DGtal/pull/1060))
- Fix wrong initialization of reverse iterators in
SimpleRandomAccess(Const)RangeFromPoint. (Roland Denis,
[#1060](https://github.com/DGtal-team/DGtal/pull/1060))

- *Geometry Package*
- Fix pseudo-random number generator in KanungoNoise (David
Expand Down Expand Up @@ -263,12 +260,12 @@
- New algorithms to compute the convex hull of planar point sets.
(Tristan Roussillon, [#1028](https://github.com/DGtal-team/DGtal/pull/1028))
- Lambda maximal segment tangent direction estimator 2D/3D: LambdaMST2D, LambdaMST3D.
A fast tangent direction estimator which uses maximal digital straight segments.
A fast tangent direction estimator which uses maximal digital straight segments.
(Kacper Pluta, [#1021](https://github.com/DGtal-team/DGtal/pull/1021))
- Segmentation of 3D digital curves by a combination of the segmentations of its 2D
- Segmentation of 3D digital curves by a combination of the segmentations of its 2D
projections onto 2D base planes: XY, XZ, YZ. Notice that, only valid projections
are used. By valid one understands that there are no two 3D points which are projected
onto the same 2D point. A segment is computed as long as is extendable and at least
onto the same 2D point. A segment is computed as long as is extendable and at least
two projections are valid.
: NaiveDSS3DComputer.
(Kacper Pluta, [#1021](https://github.com/DGtal-team/DGtal/pull/1021))
Expand Down Expand Up @@ -371,7 +368,7 @@

## Bug Fixes

- *Configuration*
- *Configuration*
- Removing code coverage with coverall.io (David Coeurjolly,
[1040](https://github.com/DGtal-team/DGtal/pull/1032)).
- Forces Eigen 3.2.1 minimum (for a bug fix). (Jacques-Olivier
Expand Down Expand Up @@ -1155,7 +1152,7 @@ Known problems:

For technical reasons, we haven’t be able to verify that this release also
compile on Windows Visual Studio systems (see ticket #87). A new release
will fix this problem as soon as possible.
will fix this problem as soon as possible.



Expand Down
39 changes: 33 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
![DGtal logo](doc/images/logoDGtal-small.png)

Main website: http://dgtal.org

Description
===========

Expand All @@ -11,20 +15,43 @@ and to construct a federative project. Another objective of DGtal is
to simplify the construction of demonstration tools to share new
results and potential efficiency of the proposed work.

DGtal is an open source free software written by researchers and students from the
DGtal research community. We wish to keep an estimate of the number of persons
using the library. This is really important for us to justify the resources spent
in developing this software. Please, take a few seconds to fill in the registration
DGtal is an opensource free software written by researchers and students from the
DGtal research community. We wish to keep an estimate of the number of persons
using the library. This is really important for us to justify the ressources spent
in developing this software. Please, take a few seconds to fill in the registration
form: http://dgtal.org/registration/

Quick Installation
==================

* Linux: [Binary packages](https://software.opensuse.org/download.html?project=home%3Acopyme%3ADGtal&package=DGtal) (Arch, CentOS, Fedora, openSUSE, RHEL, SL)
* MacOS (using [homebrew](http://brew.sh)):
brew install dgtal
(```brew options dgtal``` to enable optional features)

* Windows: no binary package, please compile the library.

Quick Build Instructions
========================

More details are given in the [documentation pages](http://dgtal.org/download/). We just sketch the main instructions on linux/unix-based systems:

git clone https://github.com/DGtal-team/DGtal.git
cd DGtal ; mkdir buid ; cd build
cmake ..
make install

Minimum system requirements: C++11 enabled compiler, [cmake](http://cmake.org), [boost](http://boost.org) (>= 1.46).

DGtal can be compiled on Microsoft Windows system using Visual Studio 2014 (or newer). Generate the Visual Studio project using windows [cmake](http://cmake.org) tool.

More Information
================

* Project homepage http://dgtal.org

* Related DGtalTools project: http://dgtal.org/tools, https://github.com/DGtal-team/DGtalTools

* Release 0.9 [![DOI](https://zenodo.org/badge/3793/DGtal-team/DGtal.svg)](https://zenodo.org/badge/latestdoi/3793/DGtal-team/DGtal)
* Release 0.8 [![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.11586.png)](http://dx.doi.org/10.5281/zenodo.11586)
* Continuous Integration [![Build Status](https://travis-ci.org/DGtal-team/DGtal.svg?branch=master)](https://travis-ci.org/DGtal-team/DGtal)

Binary file added doc/images/logoDGtal-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.