Package: rmtoo
Open Source Requirements Management ToolIntroductionThis Readme gives a short overview over the available online
documentation for rmtoo.ContentThis file contains the following chapters:Table of ContentsIntroductionContentConventionsOperating System SupportPreinstalled VMsInstallationDependenciesFirst ProjectInstallation using virtualenv / pipInstallationFirst ProjectInstallationUsageMan PagesAdditional DocumentationOther DocumentationFAQPresentationsReadme-Overview.txtReadme-Hacking.txtReadme-OS-X.txtReadme-Windows.txtReadme-RmtooOnRmtoo.txtReadme-GitPython.txtEmacs Mode for Editing RequirementsFooterConventionsYYnames the version of rmtoo.  You have to replace this with the real
version number.$ cmdThis 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 Supportrmtoo 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 readReadme-OS-X.txt.Windows users might want to read theReadme-Windows.txt.Preinstalled VMsFor evaluation proposes and running small projects there is the
possibility to use Amazon AWS EC2 preinstalled VMs.More details are available in a dedicatedReadme.InstallationThe 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.DependenciesTo use rmtoo, other software packages must be installed.rmtoo is written in python.  At least version 3.5 of python is needed.
python 3.8 may work, but there is a problem (bug (fix)?) is python 3.8
which create different XML elements as the previous versions.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 ProjectThe recommended way of starting is to copy the provided template
project.The basic steps are:Copy over the template project to some other directory.Set up the environmentRunmakeCheck, if everything workedStart changing / adapting things to your needsNote that during this document the project will be called
‘MyNewProject’.  Please adapt the name for your needs.Installation using virtualenv / pipThis is the preferred installation method - it takes care that
at least the python dependencies are correctly installed.InstallationTo installrmtooin a virtualenv, execute the following steps:$mkdirRMTOO$cdRMTOO$virtualenvvenv$sourcevenv/bin/activate$pipinstall--upgradepipsetuptoolswheel$pipinstall--only-binary=numpy,scipynumpyscipy$pipinstallrmtooThis has only to be done once.First ProjectInstallationChange to a directory where you want to create the new project. This
is needed only once.# cd to virtualenv directory - if not already there$cdRMTOO$cp-rvenv/rmtoo/contrib/template_projectMyNewProjectUsageTo create all the artifacts for the template project, execute$cdMyNewProject$source./setenv.shVENV$make$lsartifactsIn the artifacts directory there are all the generated files.
A typical workflow is, to change or add requirements, topics or the
configuration in theMyNewProjectdirectory, runmakeagain
and check the artifacts.Man PagesWhen using the virtualenv, use$man-lvenv/rmtoo/share/man/man7/rmtoo.7to 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-lvenv/rmtoo/share/man/man7/rmtoo-analytics.7Additional DocumentationAdditional documentation can be found in the directoriesRMTOO/venv/rmtoo/doc(especially the Readme files).Other DocumentationFAQFrequently asked questions
A collection of questions which were ask in the past - including
the answers.PresentationsThere 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 pagehttp://rmtoo.florath.netReadme-Overview.txtDescription of the features of rmtoo.Readme-Hacking.txtSmall (and yet unfinished) document how to develop functionality
and modules for rmtoo.Readme-OS-X.txtHints for Mac Users.Readme-Windows.txtHints for Windows users.Readme-RmtooOnRmtoo.txtRun rmtoo to get the documentation for rmtoo itself.Readme-GitPython.txtSome note about the (internal) use of GitPython.Emacs Mode for Editing RequirementsWhen using the tar package, emacs mode can be loaded in emacs by:M-xload-filepoint toRMTOO/venv/rmtoo/contrib/req-mode.elAll files with suffix.reqwill now use the requirements editing
mode.FooterIf you have some problems, remarks or feature request, you’re welcome
to visit the project home pagehttp://rmtoo.florath.netflonatel GmbH & Co. KGAndreas Florathrmtoo@florath.net(c) 2010-2012,2017,2020 by flonatel GmbH & Co. KG
For licensing details see COPYING