README
1========================================================================
2 * * * README file for QE-modes * * *
3========================================================================
4
5This is QE-modes package: an open-source collection of Emacs
6major-modes for making the editing of Quantum ESPRESSO input files
7somewhat easier and more comfortable with Emacs editor.
8
9QE-modes is free software, released under the GNU General Public
10License. See: http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt,
11
12
13Quick installation instructions for the impatient:
14--------------------------------------------------
15
161. copy the qe-modes/ subdirectory into ~/.emacs.d/ directory
172. edit and append the qe-modes.emacs file to your ~/.emacs file
18
19For more information about the installation and usage, see the file:
20Doc/user_guide.pdf
21
22
23 * * *
24
25All the material included in this distribution is free software;
26you can redistribute it and/or modify it under the terms of the GNU
27General Public License as published by the Free Software Foundation;
28either version 2 of the License, or (at your option) any later version.
29
30These programs are distributed in the hope that they will be useful, but
31WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
32or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
33for more details.
34
35You should have received a copy of the GNU General Public License along
36with this program; if not, write to the Free Software Foundation, Inc.,
37675 Mass Ave, Cambridge, MA 02139, USA.
38
README.svn
1 ========================================================================
2 * * * How to build the QE-modes from the QE SVN repository sources * * *
3 ========================================================================
4
5The QE-modes *.el and *.elc source files are automatically generated
6with the "$TOPDIR/dev-tools/gen-emacs-mode" script using the (1)
7helpdoc utility, (2) INPUT_*.def files, and (3) templates provided in
8qe-emacs.templates/ subdirectory (see the README file therein).
9
10
11To generate the QE-modes sources:
12
13make
14
15which will create the *.el and *.elc files in qe-modes/ subdirectory.
16From this point on, see the either README file or Doc/user_guide.pdf.
17
18
19To generate the QE-modes tarball:
20
21make tar
22
23
24