github/television
1
1
Fork 0
mirror of https://github.com/alexpasmantier/television.git synced 2025-06-06 11:35:25 +00:00
Code Issues 1 Packages Projects Releases Wiki Activity

docs: more work on CONTRIBUTING.md

Browse Source
This commit is contained in:
Alexandre Pasmantier 2024-11-10 19:49:38 +01:00
parent d2005e1116
commit 37fb013f0c
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -42,6 +42,25 @@ this project:
### Building the project ### Building the project
Before anything else:
```shell
make setup
```
To run the application in debug mode while developing, with the ability to see logs and debug information:
```shell
make run
```
**Accessing the Logs:**
The logs are written to a file called `television.log` in a directory that depends on your operating system /
configuration:
| Platform | Location |
|----------|----------|
| Linux | `$XDG_DATA_HOME/television/television.log` or `$HOME/.local/share/television/television.log` |
| macOS | `$XDG_DATA_HOME/television/television.log` or `$HOME/Library/Application\ Support/television/television.log` |
| Windows | `{FOLDERID_LocalAppData}\television\television.log` |
To build the project in debug mode, run the following command in the project directory: To build the project in debug mode, run the following command in the project directory:
```shell ```shell
make build_debug make build_debug