Merge pull request #123 from TeenBiscuits/mejoras-contributing

Mejoras Contributing

.reuse/dep5

@@ -3,9 +3,9 @@ Upstream-Name: Pro2324
 Upstream-Contact: Pablo Portas Lopez <[email protected]>
 Source: https://github.com/TeenBiscuits/Pro2324
 
-Files:  logo/*
+Files:  images/*
         docs/images/Logo.*
-        docs/images/GitHubSponsors.png
+        docs/images/GitHubSponsors.jpg
         docs/topics/*
 Copyright: 2023 Pablo Portas Lopez <[email protected]>
 License: CC-BY-NC-4.0

CMakeLists.txt

@@ -1,8 +1,8 @@
 # SPDX-FileCopyrightText: 2023 Pablo Portas López <[email protected]>
 #
-# SPDX-License-Identifier: CC0-1.0
+# SPDX-License-Identifier: GPL-3.0-only
 
-cmake_minimum_required(VERSION 3.26)
+cmake_minimum_required(VERSION 3.22) # Esta versión del CMake es la de Ubuntu 22.04 LTS
 project(Pro2324 C)
 
 set(CMAKE_C_STANDARD 99)

CONTRIBUTING.md

@@ -6,12 +6,25 @@ SPDX-License-Identifier: GPL-3.0-only
 
 # Introducción
 
-### Gracias por querer colaborar
+> [!IMPORTANT]  
+> **Gracias por querer colaborar**
+> 
+> Primero de todo gracias por querer colaborar con **Pro2324**, gracias a gente como tú proyectos como este són posibles.
 
-Primero de todo gracias por querer colaborar con **Pro2324**, gracias a gente como tú proyectos como este són posibles.
-😄🥰
 
-### Qué contribuciones se aceptan
+- [Introducción](#introducción)
+  - [Qué contribuciones se aceptan](#qué-contribuciones-se-aceptan)
+  - [Qué contribuciones no se aceptarán](#qué-contribuciones-no-se-aceptarán)
+- [¿Como contribuir?](#como-contribuir)
+  - [Código](#código)
+    - [Compilador](#compilador)
+  - [Documentación](#documentación)
+
+
+## Qué contribuciones se aceptan
+
+> [!TIP]
+> Soluciones a **ejercicios**, **modificaciones**, **ejemplos**, **tutoriales**, **apuntes**...
 
 Aceptamos soluciones a **ejercicios** de los boletines, modificaciones de los ya existentes o nuevos ejercicios. También
 evidentemente **parches a cualquier error** que se escape por el repositorio.
@@ -22,31 +35,41 @@ interés, también se añadirán **ejemplos** y/o **extras** que puedan resultar
 Se aceptan **explicaciones**, **apuntes** y/o **resúmenes** para los apartados de teoría. También **tutoriales** que
 sean interesantes y estén relacionados con la programación en C y/o similar.
 
-### Qué contribuciones no se aceptarán
+## Qué contribuciones no se aceptarán
 
-> **Actualización**: Debido a las normas de Pro II, no se aceptará ningún proyecto, incluso después de la fecha de entrega.
+> [!CAUTION]
+> Debido a las normas de Pro II, no se aceptará ningún proyecto, incluso después de la fecha de entrega.
 
 No se añadirá, ningún **proyecto**.
 
 Tampoco se añadirá código que no sea de creación propia o que fuera conseguido de forma ilícita.
 
 Ni se añadirán exámenes, pruebas o demás material **cuyo autor/a no expresase el consentimiento pertinente**.
 
-### ¿Como contribuir?
+# ¿Como contribuir?
 
+> [!TIP]
 > Cita siempre al autor original o a los coautores de todo lo que añadas, **hoy por ti mañana por mi**.
 
-Este Repositorio usa varias funciones de GitHub recientes, entre ellas proyectos. [Enlace al tabloide](https://github.com/users/TeenBiscuits/projects/1)
+> [!NOTE]
+> Este Repositorio usa varias funciones de GitHub recientes, entre ellas proyectos. [Enlace al tabloide](https://github.com/users/TeenBiscuits/projects/1)
 
-Cuando se añada algo que esté especificado en el tabloide, se añadirá a la **branch** ya abierta para ello.
+1. Clonar este repositorio en tu máquina.
+```bash
+git clone https://github.com/TeenBiscuits/Pro2324.git
+```
+O [descargar zip](https://github.com/TeenBiscuits/Pro2324/archive/refs/heads/main.zip) / abrir en GitHub Descktop
 
-En el caso de añadir algo nuevo, pues simplemente haz una pull request.
+2. Si vas a contribuir al [código](#código) o la [documentación](#documentación):
+   1. [CLion](https://www.jetbrains.com/clion/download) (o cualquier IDE. Ej: [VSCode](https://code.visualstudio.com/))
+   2. [Writerside](https://www.jetbrains.com/writerside/download)
 
-#### Código
+## Código
 
-**Todo el código está en la carpeta** ``./src`` **y una copia solo de los archivos** ``*.c`` **en el directorio de la
-documentación** ``./docs/code`` Esto es temporal, pero es lo mejor que se puede hacer ahora para que la documentación
-funcione.
+> [!WARNING]
+> **Todo el código está en la carpeta** ``./src`` **y una copia solo de los archivos** ``*.c`` **en el directorio de la documentación** ``./docs/code``.
+>
+>Esto es temporal, pero es lo mejor que se puede hacer ahora para que la documentación funcione.
 
 Para este proyecto se utiliza la revisión de lenguaje C, **C99** (ISO/IEC 9899:1999). El proyecto ha sido estructurado
 como un proyecto para el IDE **CLion** by JetBrains (R).
@@ -55,10 +78,11 @@ Cada boletín de la asignatura se encuentra en una sub carpeta diferente (Boleti
 parte, son una excepción a esta regla la carpeta *Ejemplos* y *Extras*, donde se añadirá el código hecho en prácticas y
 el código que se considere de interés respectivamente.
 
-Cada archivo ```*.c``` es un ejecutable diferente declarado en ``./src/*/CMakeLists.txt`` que a su vez es referenciado
-en el ``./CMakeLists.txt`` del directorio raíz. (Están todos declarados, los que todavía no fueron añadidos con
-un ``#``) Además de añadir sú código también a la carpeta ``./docs/code`` para que pueda ser referenciado más tarde en
-la documentación.
+> [!NOTE]
+> Cada archivo ```*.c``` es un ejecutable diferente declarado en ``./src/*/CMakeLists.txt`` que a su vez es referenciado en el ``./CMakeLists.txt`` del directorio raíz. (Están todos declarados, los que todavía no fueron añadidos con un ``#``)
+> 
+> Además se añadirá su código también a la carpeta ``./docs/code`` para que pueda ser referenciado más tarde en la documentación.
+
 
 Por norma general en cada boletín **solo se empleará lo aprendido en teoría hasta ese bloque**, así los ejercicios
 valdrán
@@ -83,26 +107,31 @@ Pese a la comodidad de esto, la cabecera que se añadirá será la del **reuse**
 // SPDX-License-Identifier: GPL-3.0-only
 ```
 
-_Si no es añadida por defecto, añádela, así aquellos que ven los archivos en la web sabrán quien creo el archivo._
+> [!NOTE]
+> Si no es añadida por defecto, añádela, así aquellos que ven los archivos en la web sabrán quien creo el archivo.
+
+### Compilador
 
 A la hora de compilar los ejecutables puede utilizarse cualquier compilador, pero es recomendable, en Windows,
 utilizar [Cywing](https://www.cygwin.com) (Para el correcto de display de tíldes y otros caracteres especiales).
 
 *Tutorial de configuración de Cywing en CLion en Windows
 10/11: [Link](https://www.jetbrains.com/help/clion/quick-tutorial-on-configuring-clion-on-windows.html#Cygwin)*
 
-#### Documentación
+## Documentación
+
+> [!NOTE]
+> La documentación del proyecto ha sido estructurada como un proyecto para el IDE **Writerside** by JetBrains (R).
+
+La documentación se separa en dos partes claramente diferenciadas. **Código** y **Teoría**.
 
-La documentación del proyecto ha sido estructurada como un proyecto para el IDE **Writerside** by JetBrains (R).
+El código sale de las contribuciones al repositorio principal y se añade a secciones como: Boletines, Exámenes, Tutoriales y Extras.
 
-La documentación se separa en dos partes claramente diferenciadas. Código y Teoría.
+La teoría se basa en trabajos previos readaptados a este nuevo formato. Cualquier añadido es bienvenido, siempre que mejore la calidad educativa y la sencillez de las explicaciones. 
 
-El código sale de las contribuciones al repositorio principal y se añade a secciones como: Boletines, Exámenes,
-Tutoriales y Extras.
+_Más no es siempre mejor._
 
-La teoría se basa en trabajos previos readaptados a este nuevo formato. Cualquier añadido es bienvenido, siempre que
-mejore la calidad educativa y la sencillez de las explicaciones. Más no es siempre mejor. La teoría se añade a secciones
-como: Apuntes, Ejemplos y Tutoriales.
+La teoría se añade a secciones como: Apuntes, Ejemplos y Tutoriales.
 
 Las imágenes están en subdirectorios ``./docs/images/*`` para mantener organizado la cantidad inmensa de imágenes.
 

README.md

@@ -7,7 +7,9 @@ SPDX-License-Identifier: GPL-3.0-only
 [![Banner](./logo/Pro2324%20GitHub%20Preview.png)](https://teenbiscuits.github.io/Pro2324)
 
 <div align="center">
-<h3>🌐 <a href="https://teenbiscuits.github.io/Pro2324">Página Web</a> 🌐</h3>
+
+[![Web](https://img.shields.io/badge/Página_Web-4d6aff?style=for-the-badge&logo=htmx&logoColor=#white)](https://teenbiscuits.github.io/Pro2324)[![Wuolah](https://img.shields.io/badge/Wuolah-black?style=for-the-badge&logo=googledocs&logoColor=white)](https://wuolah.com/profile/pablopl)
+
 
 [![Objetivo](https://progress-bar.dev/75/?title=Objetivo%20de%20Estrellas&width=200&color=e3b341)](https://github.com/TeenBiscuits/Pro2324)
 </div>
@@ -41,7 +43,7 @@ SPDX-License-Identifier: GPL-3.0-only
 
 <div align="right">
 <br/>
-Los apuntes y el código de este repositorio están publicados en <a href="https://teenbiscuits.github.io/Pro2324/pro2324.html">esta web</a>. 📖
+Los apuntes y el código de este repositorio están publicados en <a href="https://teenbiscuits.github.io/Pro2324/pro2324.html">esta web</a>. 📖 También están disponibles en PDF en <a href="https://wuolah.com/profile/pablopl">Wuolah</a>. 📕
 <br/>
 </div>
 
@@ -57,7 +59,7 @@ Los apuntes y el código de este repositorio están publicados en <a href="https
 
 <div align="center">
 
-[![github-sponsor](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#white)](https://github.com/sponsors/TeenBiscuits)[![ko-fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/T6T0TSIKT)[![paypalme](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/pabloportaslopez)  
+[![github-sponsor](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors)](https://github.com/sponsors/TeenBiscuits)[![Wuolah](https://img.shields.io/badge/Wuolah-4285F4?style=for-the-badge&logo=googledocs&logoColor=white)](https://wuolah.com/profile/pablopl)[![ko-fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/T6T0TSIKT)[![paypalme](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/pabloportaslopez)  
 
 </div>
 

docs/code/Ejemplos/TAD_Rational/CMakeLists.txt

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: CC-BY-4.0
 
-cmake_minimum_required(VERSION 3.26)
+cmake_minimum_required(VERSION 3.22)
 project(TAD_Rational)
 
 set(CMAKE_C_STANDARD 99)