README.md

Descripción del proyecto en una linea

About • Installation • Usage • Contributing • Credits • Support • License

---

About

Descripción larga

(Preview)

Features

	theProject	◾ Other
Feature 1	✔️	❌
Feature 2	✔️	❌

Installation

Requirements:

• Req 1 version 1.0
• Req 2 (tested with 2.0)

Downloading and installing steps (pre-build files):

• Download, fork the latest release.
• Open... the following path: \etc\theproject
• Execute, Launch in the console the following command: install.sh

Downloading, building from source and installing steps:

To build theProject, you need to have:

• Req 1 version 1.0
• Req 2 (tested with 2.0)

Steps:

• Download, fork the latest version from main branch.
• Open... the following path: \etc\theproject
• Execute, Launch in the console the following commands:

mkdir build
cd build && make

Usage

• Execute, Launch in the console the following command: run theProject

Updating

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Workflow

tl;dr: El workflow es PR a development -> Revisar preview y checks -> Asignar reviewers -> Aprobación -> Merge a development

Detailed information on how to contribute can be found on contributing.md (in spanish).

Support

Wiki

Do you need some help? Check the articles from the wiki.

FAQ

Troubleshooting

Need more support?

Reach out to us at one of the following places:

• Website at osuc
• Discord OSUC
• E-Mail: [email protected]

Credits

Maintainers

License