diff options
Diffstat (limited to 'README-hacking')
| -rw-r--r-- | README-hacking | 36 |
1 files changed, 20 insertions, 16 deletions
diff --git a/README-hacking b/README-hacking index 74cb866..7037357 100644 --- a/README-hacking +++ b/README-hacking @@ -33,57 +33,61 @@ This will be pulled automatically by the bootstrapping process. Obviously, if you are reading these notes, you did manage to check out the project from Git. The next step is to get other files needed to build, which are extracted from other source packages: 1. Change to the source tree directory cd dico 2. Run ./bootstrap +Use one or more --verbose options to see details about its progress. + Once done, proceed as described in the file README (section INSTALLATION). -Normally you will have to run bootstrap only once. However, if you -intend to hack on Dico, you might need to run it again later. In -this case, you will probably want to save some time and bandwidth by -avoiding downloading the same files again. If so, create in the project's -root directory a file named `.bootstrap' with the following -contents: - - --gnulib-srcdir=$HOME/gnulib - -Replace `$HOME/gnulib' with the actual directory where the Gnulib -sources reside. - For more information about `bootstrap', run `bootstrap --help'. * Debugging -To debug dictd, use the following command: +To debug dicod, use the following command: - libtool --mode execute gdb dictd + libtool --mode execute gdb dicod For debugging from Emacs run: - M-x gdb RET gud-wrapper dictd RET + M-x gdb RET gud-wrapper dicod RET (the script gud-wrapper is located in the ./utils subdirectory) +* Adding new modules + +If you want to add a new module to Dico (e.g. named `foo'), run the +following command from the Dico source tree topmost directory: + + ./bootstrap --add foo + +This will create the directory modules/foo, populate it with the +necessary files, and add the appropriate statements to configure.ac +and modules/Makefile.am files. + +After running this command, change to the modules/foo directory and +start hacking on your new module. + * Copyright information -Copyright (C) 2008, 2010, 2012 Sergey Poznyakoff +Copyright (C) 2008, 2010, 2012, 2016 Sergey Poznyakoff Permission is granted to anyone to make or distribute verbatim copies of this document as received, in any medium, provided that the copyright notice and this permission notice are preserved, thus giving the recipient permission to redistribute in turn. Permission is granted to distribute modified versions of this document, or of portions of it, under the above conditions, provided also that they carry prominent notices stating who last changed them. |