nästa upp förra
Nästa: Modellkommentar Upp: Installationskommentar Förra: Form

Innehåll

Försök att hålla installationskommentaren kortfattad. Säg vad man ska göra för att få produkten färdiginstallerad. Du behöver inte säga varför man ska göra det som ska göras (om det inte finns oväntade eller knepiga aspekter). Installationskommentaren ska inte vara en lärobok, den ska ofta bara vara en konfigurations- och installationssnabbguide.

Mall för innehållet i en installationskommentar

NAME
  produktnamn, version -- en (eller några få) rader som beskriver produkten.

INSTALL
  anvisningar om hur man konfigurerar och installerar produkten,
  inklusive man-blad, tex-dokument, exempelsamlingar etc.
  
INFO
  anvisningar om var det finns ytterligare information om produkten
  (noggrannare installationsanvisningar, användarhandledning etc.)
  Här anges både dokument etc. som följer med produkten; samt eventuella
  böcker, URL:er och andra externa angivelser.

NOTE
  Övrig viktig information för den som konfigurerar och installerar produkten

AUTHOR
  Den som har skapat produkten

CONTACT
  Eventuella adresser och telefonnummer om sådana finns för de som 
  behöver ytterligare hjälp eller information för produkten.

COPYRIGHT
  En copyrightnotis som kan se ut så här:
  Copyright 1997 Hubba Bubba

  Dessutom kan man ha med lättnader i de restriktioner som en copyright
  innebär. T.ex. att man får använda produkten för icke-kommersiella ändamål,
  eller att man får använda produkten hur man vill, men att den som har gjort
  produkten fortfarande har kvar rättigheterna till den.

Installationskommentar för et-paketet

NAMN
  et, version 1.0 -- a library for logging notes, warnings, errors and traces.
		
INSTALL
  To install et, cd to the directory that contains this Readme-file and
  type the following:

	make
	make test
	make man
	make install

  
  If "make test" doesn't say OK for every test, you have to figure out 
  whats wrong before installing (if you don't want a broken library installed).

  You propably need to alter the defintions in the Makefile for where to 
  install the library and the man pages. If you do not change these 
  definitions, the library will be installed in the lib directory in the
  current directory (where this Readme-file is). Also, the man pages will 
  be installed in the man directory in the current directory.

INFO
  "man et" gives more information about the et-package. Each routine is 
  also described in a man page. The source for the test programs show
  (sometimes strange) uses of the routines in the et package.

NOTE
  If you have default installed the manpages in the man directory in the 
  current directory and this directory is note part of your MANPATH, you can 
  give the command "man -M man et" to se the man page for et, for example.


AUTHOR
  Jonas Mölsä

CONTACT
  jbm@nada.kth.se
  Please mail bug reports to this address.

COPYRIGHT
  Copyright 1997 Jonas Mölsä.
  This package may be used freely for non-commercial purposes.
  For commercial use, contact the author.



Jonas Mölsä
Sat Sep 13 13:46:34 MET DST 1997