Development documentation for easier accessibility (#170)

This commit is contained in:
Ivan Skodje 2023-04-24 15:51:28 +02:00 committed by GitHub
parent 3b72e31e5d
commit 0d8d1de8bf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 50 additions and 0 deletions

View File

@ -214,3 +214,4 @@ You can contribute to this project in various ways:
- Submitting ideas, and reporting issues in the [tracker](https://github.com/linuxmint/timeshift/issues)
- Translating this application to other languages in [Launchpad](https://translations.launchpad.net/linuxmint/latest/+translations)
- Contributing code changes by fixing issues and submitting a pull request (do not modify translations, this is done in Launchpad)
- To get started with coding, see the [development](/docs/development.md) docs

49
docs/development.md Normal file
View File

@ -0,0 +1,49 @@
# Timeshift Development
This documentation provides instructions for developing Timeshift.
## Prerequisites
- make
- gettext
- valac
- libvte-2.91-dev
- libgee-0.8-dev
- libjson-glib-dev
If you are using a Debian-based distribution, you can install these dependencies by running the following command in a terminal:
```bash
sudo apt install make \
gettext \
valac \
libvte-2.91-dev \
libgee-0.8-dev \
libjson-glib-dev
```
## Building and Installing
### Step 1. Clone the Timeshift repository
```bash
git clone git@github.com:linuxmint/timeshift.git
```
### Step 2. Navigate to the Timeshift folder
```bash
cd timeshift
```
### Step 3. Build Timeshift
```bash
make
```
### Step 4. Install Timeshift
```bash
sudo make install
```