|
|
|
Create a manifest.yml file in the root of your rails app and commit it along with the rest of your code. If you have the `awesim_rails` gem included, you can do that by running a rake task:
|
|
|
|
|
|
|
|
```sh
|
|
|
|
$ rake awesim:manifest
|
|
|
|
manifest.yml created in root of rails app
|
|
|
|
$
|
|
|
|
```
|
|
|
|
|
|
|
|
Here is an example:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
name: Fill Sim
|
|
|
|
description: |
|
|
|
|
FillSim is an interactive and easy to use web app that models complex fluid
|
|
|
|
dynamics in a user-supplied container.
|
|
|
|
documentation: |
|
|
|
|
[Documentation](https://www.osc.edu/some/link/to/documentation.html)
|
|
|
|
```
|
|
|
|
|
|
|
|
* name: The title of the app
|
|
|
|
* description: a multi-line markdown formatted string
|
|
|
|
* documentation: a multi-line markdown formatted string
|
|
|
|
|
|
|
|
YAML lets you create multiline string values for a key using the pipe. Everything on the next line and after thats indented the same number of spaces together is used as the value.
|
|
|
|
|
|
|
|
This means you can have bullet lists and links and bold and underline etc. This manifest information is what is displayed in the dashboard at https://apps.awesim.org/devapps |
|
|
\ No newline at end of file |
