6. Cómo presentar el trabajo

En el repositorio tiene que haber:

• Un archivo .c con código (o varios ficheros .cy .h si utilizáis librerías propias). Este archivo se ha tenido que ir actualizando vía GitHub Desktop. Tened en cuenta que será motivo de evaluación los commits realizados, tanto la cantidad y calidad de los mismos, como la participación activa de todos los componentes del grupo.
• Un archivo README.mdcon la propuesta inicial del trabajo.
• En caso de trabajar con ARDUINO, las librerías externas utilizada.
• Un archivo .gitignore y un LICENSE, archivos que se incluyen por defecto cuando se creó el repositorio con GitHub Classroom.
• El diagrama de flujo previsto para vuestro programa en un fichero en formato PDF, GIF, JPEG o PNG (no se admiten documentos Word o similar). En este enlace de Wikipedia tenéis información sobre diagramas de flujo.
• Un logo de vuestro trabajo. La imagen debe llamarse: logo.png (en minúsculas) y sus dimensiones deben ser: 400 x 289 píxeles. Esta imagen debéis añadirla al nivel básico de vuestro repositorio (donde estén vuestros LICENSE y Readme.md). Aquí proponemos una web útil en caso de que necesitéis modificar el tamaño o formato de vuestra imagen.

Además, debéis incluir una Wiki donde expliquéis los resultados que habéis obtenido, el código que habéis utilizado y el porqué, así como otros puntos interesantes de vuestro trabajo. ¿Qué es una Wiki?¿Dónde encuentro la Wiki de mi repositorio?

• Una Wiki es una página de Internet donde múltiples usuarios pueden editar el contenido de la misma de manera rápida y sencilla.
• Puedes acceder a la Wiki de cualquier repositorio desde las pestañas superiores de la página.

¿Qué tenéis que exponer en la Wiki de vuestro repositorio?

Igual que el informe de otros trabajos académicos se debe presentar en formato PDF o con una presentación estilo PowerPoint, en el trabajo de Informática deberéis exponer lo que habéis desarrollado en la Wiki, de la misma forma que nosotros os publicamos las páginas explicativas. Por ello deberá contener,

• Explicación del contenido del trabajo y sus objetivos iniciales, y opcionalmente, una comparación con el resultado final.
• Funcionalidades implementadas, apoyándoos en imágenes de la salida por consola y una breve explicación de las mismas.
• Una breve guía de utilización de vuestro programa, es decir, un tutorial para que cualquier persona pueda utilizarlo.
• Explicación sobre las funciones implementadas, sus prototipos y el porqué de la organización que habéis elegido. Se podrán poner de manera ilustrativa comentarios del código (Cómo insertarlos lo veremos más adelante).
• En caso de utilizar ficheros, una explicación de los ficheros utilizados, su formato ( orden en el que se guardan los datos, espaciado etc.), su utilidad, y cómo se realiza el acceso a los datos que contienen.
• Todo lo que se os ocurra para poder exponer vuestro trabajo lo mejor posible (Ejemplo: Vídeo de una traza de ejecución)

Subir contenido a la Wiki y dar formato al texto

• La Wiki debe editarse siempre desde la web porque no es un archivo portable.
• Sigue los criterios para dar formato MarkDown. Podéis ver un resumen de los aspectos fundamentales del estilo en esta página de la Wiki del Punto_inicio : Markdown A continuación expondremos los puntos extra básicos que podéis necesitar para la Wiki de vuestro trabajo.

Incluir imágenes

Para poder poner imágenes en vuestra Wiki debéis en primer lugar subir las fotos a una carpeta llamada Images que crearéis en el repositorio. Después simplemente se hace referencia a la ubicación del archivo en GitHub con su link y el siguiente formato:

![](https://github.com/aigora/punto_inicio/blob/master/images/Ejemplo_Wiki.png)

Y el resultado es,

El link que debéis introducir es el que se obtiene al pinchar sobre la imagen de la carpeta Images en GitHub. Es decir,

Incluir fragmentos de código

Es importante que si incluis fragmentos del código para explicarlo o exponerlo quede diferenciado del resto del texto. Para ello,

• Si vais a introducir una linea de código dentro del texto, por ejemplo,

"A la función void Perfil(cliente) se le pasa como argumento una estructura que contiene los datos del cliente para mostrarlos por pantalla"

Debéis poner la línea de código entre comillas invertidas (o acentos graves) y conseguiréis un resultado como el de la oración anterior:

`void Perfil(cliente)`

Si en vez de una línea dentro del código queréis poner un bloque de código, el formato es el siguiente:

```

int main(){

printf("hola");

}

```

Siendo ```, acentos graves. Y conseguiréis que el resultado sea el siguiente

int main(){
 printf("hola");
}

Esto os permitirá poner pequeños fragmentos de código y poder hacer aclaraciones sobre ellos en la Wiki.

Extras

Recordad que podréis incluir cualquier material que aclare cómo funciona vuestro trabajo y cómo lo habéis desarrollado,
Algunas posibilidades, sin ser en ningún caso obligatorias:

• Links a cualquier archivo de vuestro repositorio (Por ejemplo, al diagrama de flujo). La información sobre cómo hacerlo la tenéis en la página de la Wiki del Punto_Inicio dedicada a Markdown.
• Vídeo de una prueba de ejecución. Hay múltiples herramientas gratuitas para poder capturar la salida por pantalla y otras para editar los vídeos creados. Por ejemplo, podéis usar el programa OBS para realizar un video de la pantalla pero hay muchos más, todos ellos sencillos de utilizar.
• Cualquier cosa que penséis que ayuda a entender vuestro trabajo.