From 6821dc2819e62ab83a45a6ebd6828961b6afa9b5 Mon Sep 17 00:00:00 2001 From: alemuntoni Date: Tue, 28 Jan 2020 12:10:01 +0100 Subject: [PATCH] renaming readmes --- README.md | 12 ++++++------ distrib/README.md | 0 docs/{readme.txt => README.md} | 0 install/{readme.txt => README.md} | 0 sample/{readme.txt => README.md} | 0 5 files changed, 6 insertions(+), 6 deletions(-) create mode 100644 distrib/README.md rename docs/{readme.txt => README.md} (100%) rename install/{readme.txt => README.md} (100%) rename sample/{readme.txt => README.md} (100%) diff --git a/README.md b/README.md index 272c2d5fc..430100168 100644 --- a/README.md +++ b/README.md @@ -42,12 +42,12 @@ We provide a set of scripts that allows to compile and deploy meshlab for every The MeshLab repository is organized as follows: -* `distrib` -* `docs` -* `install` -* `sample` -* `src` -* `vcglib` +* `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; +* `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; +* `vcglib`: submodule of [VCGLib](https://github.com/cnr-isti-vclab/vcglib). # License diff --git a/distrib/README.md b/distrib/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/readme.txt b/docs/README.md similarity index 100% rename from docs/readme.txt rename to docs/README.md diff --git a/install/readme.txt b/install/README.md similarity index 100% rename from install/readme.txt rename to install/README.md diff --git a/sample/readme.txt b/sample/README.md similarity index 100% rename from sample/readme.txt rename to sample/README.md