Skip to content

Commit

Permalink
added links to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@alemuntoni
alemuntoni committed Feb 12, 2020
1 parent 7230ac2 commit 42c0b80
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 26 deletions.
12 changes: 6 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,18 @@ Right now, the portable version of meshlab won't start if doesn't find a Visual

# Build instructions

We provide a set of scripts that build and deploy automatically MeshLab. All the scripts can be found in the `meshlab/install` folder.
For specific build instructions see the `meshlab/src` folder.
We provide a set of scripts that build and deploy automatically MeshLab. All the scripts can be found in the [install](https://github.com/cnr-isti-vclab/meshlab/tree/master/install) folder.
For specific build instructions see the [src](https://github.com/cnr-isti-vclab/meshlab/tree/master/src) folder.

# Structure of the Repository

The MeshLab repository is organized as follows:

* `distrib`: this folder contains a set of prebuilt libraries, shaders and plugins that will be used by MeshLab once it is compiled. Binaries and plugins will be placed in this folder after MeshLab is built, or a copy of this folder will be placed in the chosen shadow build directory. For more details, check the readme file inside the folder;
* `docs`: doxygen scripts for generating MeshLab documentation. For more details, check the readme file inside the folder;
* `install`: in this folder there are a set of platform-dependent script to build and deploy MeshLab. For more details, check the readme file inside the folder;
* `distrib`: this folder contains a set of prebuilt libraries, shaders and plugins that will be used by MeshLab once it is compiled. Binaries and plugins will be placed in this folder after MeshLab is built, or a copy of this folder will be placed in the chosen shadow build directory. For more details, check the readme [here](https://github.com/cnr-isti-vclab/meshlab/tree/master/distrib);
* `docs`: doxygen scripts for generating MeshLab documentation. For more details, check the readme [here](https://github.com/cnr-isti-vclab/meshlab/tree/master/docs);
* `install`: in this folder there are a set of platform-dependent script to build and deploy MeshLab. For more details, check the readme [here](https://github.com/cnr-isti-vclab/meshlab/tree/master/install);
* `sample`: a set of files (meshes, images) used for tests;
* `src`: this folder contains all the source code of MeshLab, its plugins and the external libraries that it requires. For more details, check the readme file inside the folder;
* `src`: this folder contains all the source code of MeshLab, its plugins and the external libraries that it requires. For more details, check the readme [here](https://github.com/cnr-isti-vclab/meshlab/tree/master/src);
* `vcglib`: submodule of [VCGLib](https://github.com/cnr-isti-vclab/vcglib).

# License
Expand Down
4 changes: 2 additions & 2 deletions distrib/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The distrib folder contains a set of pre-built libraries, plugins, shaders and textures that MeshLab needs to properly run.

Running `qmake && make` from the `src` folder of the repo, MeshLab binaries, plugins and libraries will be placed automatically in this folder.
Running `qmake && make` from the [src](https://github.com/cnr-isti-vclab/meshlab/tree/master/src) folder of the repo, MeshLab binaries, plugins and libraries will be placed automatically in this folder.
If instead a shadow build is set, the `distrib` folder will be automatically copied inside the selected build directory, and it will contain also binaries, plugins and libraries.

After building MeshLab, the `distrib` directory will **not** contain a portable version of MeshLab, since it won't contain all the Qt's libraries needed by MeshLab. In order to deploy MeshLab, see the `install` directory.
After building MeshLab, the `distrib` directory will **not** contain a portable version of MeshLab, since it won't contain all the Qt's libraries needed by MeshLab. In order to deploy MeshLab, see the [install](https://github.com/cnr-isti-vclab/meshlab/tree/master/install) directory.
12 changes: 8 additions & 4 deletions install/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,14 @@ This folder contains a series of platform-dependent scripts to build and deploy

Every platform folder contains:

* `$platform$-build.[sh/ps1]`: a script that builds MeshLab. Requires a Qt environment properly set, with `qmake` accessible. Binaries will be placed inside `$1/distrib`, where `$1` is the argument that represents the build directory, or in the `distrib` folder if arguments were not provided.
* `$platform$-deploy.[sh/ps1]`: a script that deploys MeshLab, making sure that the folder will be a self-contained MeshLab, without Qt library dependencies. Requires a properly built MeshLab in the directory passed as an argument, or in the `distrib` folder if arguments were not provided.
* `$platform$-install.[sh/ps1]`: a script that computes a self-contained package/installer of MeshLab. Requires a properly deployed MeshLab in the directory passed as an argument, or in the `distrib` folder if arguments were not provided. The result will be saved in the same directory.
* `$platform$-build.[sh/ps1]`: a script that builds MeshLab. Requires a Qt environment properly set, with `qmake` accessible. Binaries will be placed inside `$1/distrib`, where `$1` is the argument that represents the build directory, or in the [distrib](https://github.com/cnr-isti-vclab/meshlab/tree/master/distrib) folder if arguments were not provided.
* `$platform$-deploy.[sh/ps1]`: a script that deploys MeshLab, making sure that the folder will be a self-contained MeshLab, without Qt library dependencies. Requires a properly built MeshLab in the directory passed as an argument, or in the [distrib](https://github.com/cnr-isti-vclab/meshlab/tree/master/distrib) folder if arguments were not provided.
* `$platform$-install.[sh/ps1]`: a script that computes a self-contained package/installer of MeshLab. Requires a properly deployed MeshLab in the directory passed as an argument, or in the [distrib](https://github.com/cnr-isti-vclab/meshlab/tree/master/distrib) folder if arguments were not provided. The result will be saved in the same directory.
* `$platform$-make_it.[sh/ps1]`: a script that computes all the three previous scripts: starting from the source code, it will produce a self-contained package/installer of MeshLab.
* various other files used by the scripts listed above.

See in each platform subfolder if there are some other platform-dependent requirements.
See in each platform subfolder for details and other platform-dependent requirements:

- [Linux](https://github.com/cnr-isti-vclab/meshlab/tree/master/install/linux)
- [MaxOS](https://github.com/cnr-isti-vclab/meshlab/tree/master/install/macos)
- [Windows](https://github.com/cnr-isti-vclab/meshlab/tree/master/install/windows)
8 changes: 4 additions & 4 deletions install/macos/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ The follwing scripts are provided:
Building meshlab on a clean MacOS environment (compiled MeshLab in `meshlab/distrib`):

git clone --recursive https://github.com/cnr-isti-vclab/meshlab
bash meshlab/install/macos/macos_setup_env.sh
bash meshlab/install/macos/macos_build.sh
sh meshlab/install/macos/macos_setup_env.sh
sh meshlab/install/macos/macos_build.sh

Building and generating DMG on a clean MacOS environment, build directory in `~/build_meshlab`:

git clone --recursive https://github.com/cnr-isti-vclab/meshlab
bash meshlab/install/macos/macos_setup_env.sh
bash meshlab/install/macos/macos_make_it.sh ~/build_meshlab
sh meshlab/install/macos/macos_setup_env.sh
sh meshlab/install/macos/macos_make_it.sh ~/build_meshlab

Meshlab*.dmg can be found in `~/build_meshlab/distrib/`.
15 changes: 5 additions & 10 deletions src/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,11 @@ In the `src` folder there are several folders containing all the source code and

The source code of MeshLab is structured in the following folders:

* external: it contains a series of external libraries needed by several plugins. Some of these libraries are compiled before the compilation of meshlab, if a corresponding systme library is not found and then linked; some other libraries are just included by some plugins.
* common: a series of utility functions used by MeshLab and its plugins.
* meshlab: the GUI of the MeshLab application.
* meshlabserver: a tool that allows to compute mesh operations through command line
* meshlabplugins: all the plugins that can be added to MeshLab.

There are also a set of sample plugins:

* sampleplugins.
* [external](https://github.com/cnr-isti-vclab/meshlab/tree/master/src/external): it contains a series of external libraries needed by several plugins. Some of these libraries are compiled before the compilation of meshlab, if a corresponding systme library is not found and then linked; some other libraries are just included by some plugins.
* [common](https://github.com/cnr-isti-vclab/meshlab/tree/master/src/common): a series of utility functions used by MeshLab and its plugins.
* [meshlab](https://github.com/cnr-isti-vclab/meshlab/tree/master/src/meshlab): GUI and core of MeshLab.
* [meshlabserver](https://github.com/cnr-isti-vclab/meshlab/tree/master/src/meshlabserver): a tool that allows to compute mesh operations through command line
* [meshlabplugins](https://github.com/cnr-isti-vclab/meshlab/tree/master/src/meshlabplugins): all the plugins that can be added to MeshLab.

The following folders are used by `cmake`:

Expand Down Expand Up @@ -60,7 +56,6 @@ MeshLab has a plugin architecture and therefore all the plugins are compiled sep
make

This configuration contains the info for building meshlab with a minimal set of plugins.
[//]: # (TODO: jhead does not allow to add this: with no external dependencies and usually compile with no problem.)

Some plugins of MeshLab need external libraries. All the required libraries are included in the `meshlab/src/external` folder, that are automatically compiled before MeshLab in all its configurations.

Expand Down

0 comments on commit 42c0b80

Please sign in to comment.