Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

  • c4770e8
  • /
  • tex
  • /
  • README.md
Raw File Download

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
content badge
swh:1:cnt:12a19fca6e9aaf328cfa97c547cff0085c9466a8
directory badge
swh:1:dir:63a309dbe7592e501edc2e9038bfef708da35298

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
README.md
Directory containing LaTeX-related files
----------------------------------------

Copyright (C) 2018-2020 Mohammad Akhlaghi <mohammad@akhlaghi.org>\
See the end of the file for license conditions.

This directory contains directories to various components the LaTeX part of
the project. In a running project, it will contain the atleast the
following sub-directories. Note that

- The `src/` directory contains the LaTeX files that are loaded into
  `paper.tex`. This includes the necessary preambles, the LaTeX source
  files to build tables or figures (for example with TiKZ or PGFPlots), and
  etc.  These files are under version-control and an integral part of the
  project's source.

- The `build/` directory contains all the built products (not source!) that
  are created during the analysis and are necessary for building the
  paper. This includes figures, plots, images, table source contents and
  etc. Note that this directory is not under version control.

- The `tikz/` directory is only relevant if some of the project's figures
  are built with the LaTeX packages of TiKZ or PGFPlots. It points to the
  directory containing the figures (in PDF) that were built by these tools.
  Note that this directory is not under version control.

The latter two directory and its contents are not under version control, so
if you have just cloned the project or are viewing its contents on a
browser, they don't exist. They will be created after the project is
configured for the running system.

When the full project is build from scratch (building the software,
downloading necessary datasets, running the analysis and building the
paper's PDF), the latter two directories will be symbolic links to special
places under the Build directory.

However, when the distributed tarball is used to only build the PDF paper
(without doing any analysis), the latter two directories will not be
symbolic links and will contain the necessary components for the paper to
be built.





### Copyright information
This file is part of Maneage (https://maneage.org).

This file is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.

This file is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License along
with this file.  If not, see <http://www.gnu.org/licenses/>.

back to top

Software Heritage — Copyright (C) 2015–2025, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API