diff --git a/README.md b/README.md index 6b48aa2bbf..8a2d779c5e 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,13 @@ make make install # try "sudo make install" if you don't have the permission to write ``` +## Get in Touch + +The main channel to reach the WRENCH team is via the support email: +[support@wrench-project.org](mailto:support@wrench-project.org?subject=WRENCH Support Contact: Your Topic). + +**Bug Report / Feature Request:** our preferred channel to report a bug or request a feature is via +WRENCH's [Github Issues Track](https://github.com/wrench-project/wrench/issues). [travis-badge]: https://travis-ci.org/wrench-project/wrench.svg?branch=master diff --git a/doc/getting_started.md b/doc/getting_started.md index df417c4d66..5fe073f801 100644 --- a/doc/getting_started.md +++ b/doc/getting_started.md @@ -95,7 +95,7 @@ your own algorithms and services. @endWRENCHDoc -## Building Your CMakeLists.txt File ## {#getting-started-prep-cmakelists} +## Creating Your CMakeLists.txt File ## {#getting-started-prep-cmakelists} Below is an example of a `CMakeLists.txt` file that can be used as a starting template for developing a WRENCH application compiled using cmake: @@ -158,6 +158,10 @@ Internal developers are expected to **contribute** code to WRENCH's core compone Please, refer to the [API Reference](./annotated.html) to find the detailed documentation for WRENCH functions. +> **Note:** It is strongly recommended that WRENCH internal developers (contributors) +> _fork_ WRENCH's code from the [GitHub repository](http://github.com/wrench-project/wrench), +> and create pull requests with their proposed modifications. + In addition to the common [installation steps](./install.html), WRENCH's internal developers are strongly encouraged to install the following dependencies/tools: diff --git a/doc/index.md b/doc/index.md index 1bd04ee9fc..83acf68446 100644 --- a/doc/index.md +++ b/doc/index.md @@ -52,8 +52,6 @@ WRENCH comprises four distinct modules, each designed as a simulation component: ![Overview of the WRENCH architecture.](images/wrench-architecture.png) -
- # Classes of Users # {#overview-users} WRENCH is intended for three different classes of users: @@ -85,3 +83,11 @@ provides, in addition to all levels above, a detailed documentation for all WREN including binders to SimGrid. @WRENCHNotInternalDoc ([See Internal Documentation](../internal/index.html)) @endWRENCHDoc + +# Get in Touch # {#overview-contact} + +The main channel to reach the WRENCH team is via the support email: +[support@wrench-project.org](mailto:support@wrench-project.org?subject=WRENCH Support Contact: Your Topic). + +**Bug Report / Feature Request:** our preferred channel to report a bug or request a feature is via +WRENCH's [Github Issues Track](https://github.com/wrench-project/wrench/issues).