File README.md

Last commit: Tue Dec 24 13:22:02 2024 +0100	Jan Dankert	Documentation...


     1 # DIT ("Deliver it")
     2 
     3 DIT is a batch tool for delivering software
     4 
     5 ## Features
     6 
     7 - Build a website for browsing the repository
     8 - Build a project site
     9 - Build an archive website for all tags
    10 - Pushing to GITHUB repositories
    11 - Pushing to remote repositories via SSH
    12 - Build docker images for all tags
    13 
    14 ## Install
    15 
    16 ### GIT Hook
    17 
    18 Install a global GIT hook
    19 
    20 In `~/.gitconfig`:
    21 
    22     ...
    23     [core]
    24     hooksPath = /path-to-this-repo/git-hooks
    25 
    26 If done, DIT will be executed after every push.
    27 
    28 ### Configuration
    29 
    30 Copy the file `config/config-default.sh` to
    31 - `~/.config/dit` or
    32 - `/etc/dit`
    33 and enable the modules to your need.
    34 
    35 ## Documentation
    36 
    37 Every project may contain a file named `.dit.yml`, which should have values like:
    38 ```
    39 project:
    40   name: "your-repo"
    41   title: "your project title"
    42   description: "a brief description of your project"
    43   author: Your name
    44   email: "yourmail@example.com"
    45 
    46 modules:
    47   archive: on
    48   docker: off
    49   github: off
    50   public: true
    51   site: on
    52   sshpush: on
    53 ```
    54 
    55 If the file does not exist, DIT will use default values:
    56 - The project name is the directory name in which your GIT repo resists.
    57 - The title will be taken from the project name
    58 - Author information will be taken from the last commit
    59 - All enabled modules will be executed



Download README.md


History
Tue, 24 Dec 2024 13:22:02 +0100	Jan Dankert	Documentation...
Tue, 26 Nov 2024 23:26:36 +0100	Jan Dankert	New: Creating a project website
Sun, 12 May 2024 19:53:02 +0200	Jan Dankert	first edition of DIT, the delivery expert.