forked from vakaras/rmtoo
-
Notifications
You must be signed in to change notification settings - Fork 0
A fork of requirements management tool – rmtoo.
License
oscarpicas/rmtoo
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ THIS IS SOFTWARE! IT MAY HARM YOU, YOUR COMPUTER, SOFTWARE AND DATA! USE AT YOUR OWN RISK! ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ * Introduction This Readme gives a short overview over the available online documentation for rmtoo. * Content This file contains the following chapters: o Conventions o Operating System Support o Installation - Dependencies o First Project o Debian Squeeze (.deb package) - Installation - First Project - Man Pages o Using tar package - Installation - First Project - Man Pages o Additional Documentation o Emacs Mode for Editing Requirements o Footer * Conventions 'YY' names the version of rmtoo. You have to replace this with the real version number. '$ cmd' This is a command you have to type in. The "$" is a replacement for the shell prompt - do not enter it as a part of the command. * Operating System Support rmtoo is fully supported under Linux. Nevertheless, because it is written in computer independent programming languages (such as python), is also works on other operating systems. Mac OS X users might want to read Readme-OS-X.txt. Windows users might want to read the Readme-Windows.txt. * Installation A .deb package is available for Debian 6 (Squeeze) only. On all other systems, including Ubuntu, the provided tar package should be used. The following sections assume, that you are using Linux. Please refer to the appropriate Readme file for your operating system for more information if you do not use Linux. ** Dependencies To use rmtoo, other software packages must be installed. rmtoo is written in python. At least version 2.6 of python is needed. When you want to create LaTeX or PDF documentation, LaTeX is needed. For the requirements dependency graph, graphviz is used. For statistics plot gnuplot is used. For the estimation module the python-scipy package is needed. Typically the packages from your distribution will work. * First Project The recommended way of starting is to copy the provided template project. Using the provided template projects depends whether you use the deb package or the tar package. Please consult the appropriate sections how to use the template project. Nevertheless the basic steps are: 1) Copy over the template project to some other directory. 2) Set up the environment 3) Run 'make' 4) Check, if everything worked 5) Start changing / adapting things to your needs Note that during this document the project will be called 'MyNewProject'. Please adapt the name for your needs. * Debian Squeeze (.deb package) ** Installation When you use Debian Squeeze, you can use the provided .deb package. To install it, you need to be root: # dpkg -i rmtoo_YY_all.deb ** First Project Change to a directory where you want to create the new project. $ cp -r /usr/share/doc/rmtoo/examples/template_project MyNewProject $ cd MyNewProject $ source ./setenv.sh DEB $ make $ ls artifacts In the artifacts directory there are all the generated files. ** Man Pages The rmtoo man pages are installed in the system. Please use $ man rmtoo to get an overview over all available man pages. Those other man pages you can read also with just 'man [name_of_the_page]', like $ man rmtoo-analytics ** Additional Documentation Additional documentation can be found in the directory: /usr/share/doc/rmtoo Please consult the chapter 'Additional Documentation' below for a list of available additional documentation. * Using tar package ** Installation Just untar the downloaded package. You need not to be root to do this. Change to the directory where you want to install rmtoo to. To refer to the current directory, it is called RMTOO_BASE_PATH. $ export RMTOO_BASE_PATH=$PWD $ tar -xvf rmtoo-YY.tar.gz To use rmtoo, you have to include '${RMTOO_BASE_PATH}/rmtoo-YY/bin' to your path, include '${RMTOO_BASE_PATH}/rmtoo-YY' to your PYTHONPATH. When you use the template project (see section 'First Project' some lines below), the shell script 'setenv.sh' is doing this for you. ** First Project Change to a directory where you want to create the new project. $ cp -r ${RMTOO_BASE_PATH}/rmtoo-YY/contrib/template_project MyNewProject $ cd MyNewProject $ source ./setenv.sh ${RMTOO_BASE_PATH}/rmtoo-YY $ make $ ls artifacts In the artifacts directory there are all the generated files. ** Man Pages The man pages are located in the sub-directory doc/man. Please use the command $ man -l ${RMTOO_BASE_PATH}/rmtoo-YY/doc/man/rmtoo.7 to get an overview over all available man pages. Those other man pages you can read also with man. Replace the file name with the appropriate manual page, like: $ man -l ${RMTOO_BASE_PATH}/rmtoo-YY/doc/man/rmtoo-analytics.7 ** Additional Documentation Additional documentation can be found in the directories ${RMTOO_BASE_PATH}/rmtoo-YY (especially the Readme files) ${RMTOO_BASE_PATH}/rmtoo-YY/doc/other Please consult the chapter 'Additional Documentation' below for a list of available additional documentation. Please note: some documentation is in a * Other Documentation ** FAQ Frequently asked questions A collection of questions which were ask in the past - including the answers. ** Presentations There are also two presentations about the design and features of rmtoo. Theese presentations can be found in the download section of the sourceforge project page. Please visit the projects home page http://www.flonatel.de/projekte/rmtoo for appropriate links. ** Readme-Overview.txt Description of the features of rmtoo. ** Readme-Hacking.txt Small (and yet unfinished) document how to develop functionality and modules for rmtoo. ** Readme-OS-X.txt Hints for Mac Users. ** Readme-Windows.txt Hints for Windows users. ** Readme-RmtooOnRmtoo.txt Run rmtoo to get the documentation for rmtoo itself. ** Readme-GitPython.txt Some note about the (internal) use of GitPython. * Emacs Mode for Editing Requirements When using the deb package, files with end on '.req' are automatically recognized as requirements files. When using the tar package, emacs mode can be loaded in emacs by: M-x load-file point to ${RMTOO_BASE_PATH}/rmtoo-YY/contrib/req-mode.el All files with suffix .req will now use the requirements editing mode. * Footer If you have some problems, remarks or feature request, you're welcome to visit the project home page http://www.flonatel.de/projekte/rmtoo or the sourceforge project page http://sourceforge.net/projects/rmtoo or write a mail. Andreas Florath sf@flonatel.org 2011-11-26 Local Variables: mode:outline End:
About
A fork of requirements management tool – rmtoo.
Resources
License
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published
Languages
- Python 92.4%
- TeX 4.8%
- C 2.1%
- Makefile 0.3%
- Emacs Lisp 0.2%
- Shell 0.2%