README
Copyright © 2017,2019-2021 Félicien Pillot <felicien@gnu.org>
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without any warranty.

  #####################################
 ##   Brief description of TutoTerm   ##
  #####################################

TutoTerm is a simple terminal emulator that includes interactive
documentation for the novice user. It is a tutorial which seeks to
help you discover and make yours the command line world, and thus take
a step further towards expert GNU/Linux computing.  While the user is
typing commands, the program displays information and examples about
it, and it explains what happens after the command has run.  It aims
to follow up on the user's learning, propose exercises of increasing
complexity, and maybe even evaluate to validate her skills.

  #####################################
 ##        COMPILING INSTRUCTIONS     ##
  #####################################

## Get/update the sources

`$ sudo apt-get install cvs`
`$ cvs ...`

## Install build-dependencies

From Debian/Ubuntu-based distros :

`$ sudo apt-get install build-essential libglib2.0-dev libxml2-utils libxml2-dev libvte-2.91-dev libgtk-3-dev`

## Build the sources

`$ ./configure`
`$ make`
`$ sudo make install`

## Run the software

`$ tutoterm`

  #####################################
 ##          HOW TO CONTRIBUTE        ##
  #####################################

## Add command descriptions to the XML file

The file data/command-descriptions.xml contains, for each command listed, the "description", "example" and "posttext" fields.
You can copy/paste/modify a section of that file to add your owned commands.
Then you can add translations for it by running `$ make update-po` in the po/ directory, and then writing down the translated strings in po/$LANG.po
After that recompile the sources again (don't forget to install it system-wide) and test your modifiations!

Patches can be sent to <felicien@gnu.org>
