Skip to content

Commit

Permalink
WRENCH documentation: get in touch section, and minor updates to gett…
Browse files Browse the repository at this point in the history
…ing started page
  • Loading branch information
rafaelfsilva committed Nov 29, 2017
1 parent 4f22065 commit 3807172
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 3 deletions.
7 changes: 7 additions & 0 deletions README.md
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion doc/getting_started.md
Expand Up @@ -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:
Expand Down Expand Up @@ -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:

Expand Down
10 changes: 8 additions & 2 deletions doc/index.md
Expand Up @@ -52,8 +52,6 @@ WRENCH comprises four distinct modules, each designed as a simulation component:
![Overview of the WRENCH architecture.](images/wrench-architecture.png)


<br />

# Classes of Users # {#overview-users}

WRENCH is intended for three different classes of users:
Expand Down Expand Up @@ -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).

0 comments on commit 3807172

Please sign in to comment.