diff --git a/README.md b/README.md index 6cb5740..9e4ae31 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 0000000..611e4fb --- /dev/null +++ b/docs/development.md @@ -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 +``` \ No newline at end of file