aboutsummaryrefslogtreecommitdiff
path: root/about.html
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2019-03-05 21:16:48 +0100
committerRobert Alessi <alessi@robertalessi.net>2019-03-05 21:16:48 +0100
commitda60a4f5c772acb67e5ed681d2335651d1dbbcd6 (patch)
tree1eb89357441797d9f5cec51d41de396a1b9c1671 /about.html
parent144c4c8662089094eac38d906f571e3f5aefbee6 (diff)
downloadicite-da60a4f5c772acb67e5ed681d2335651d1dbbcd6.tar.gz
done documenting icite
Diffstat (limited to 'about.html')
-rw-r--r--about.html58
1 files changed, 58 insertions, 0 deletions
diff --git a/about.html b/about.html
new file mode 100644
index 0000000..4c88021
--- /dev/null
+++ b/about.html
@@ -0,0 +1,58 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5 <meta http-equiv="Content-Style-Type" content="text/css" />
6 <meta name="generator" content="pandoc" />
7 <meta name="author" content="Robert Alessi" />
8 <title>The icite package – README file</title>
9 <style type="text/css">code{white-space: pre;}</style>
10</head>
11<body>
12<div id="header">
13<h1 class="title">The icite package – README file</h1>
14<h2 class="author">Robert Alessi</h2>
15</div>
16<h1 id="overview">Overview</h1>
17<p><code>icite</code> is designed to produce from BibTeX or BibLaTeX bibliographical databases the different indices of authors and works cited which are called . It relies on a specific <code>\icite</code> command and can operate with either BibTeX or BibLaTeX.</p>
18<h1 id="license-and-disclamer">License and disclamer</h1>
19<p>icite – Indices locorum citatorum</p>
20<p>Copyright ⓒ 2019 Robert Alessi</p>
21<p>Please send error reports and suggestions for improvements to Robert Alessi:</p>
22<ul>
23<li><p>email: <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li>
24<li><p>website: <a href="http://www.robertalessi.net/icite" class="uri">http://www.robertalessi.net/icite</a></p></li>
25<li><p>comments, feature requests, bug reports: <a href="https://gitlab.com/ralessi/icite/issues" class="uri">https://gitlab.com/ralessi/icite/issues</a></p></li>
26</ul>
27<p>This program 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.</p>
28<p>This program 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.</p>
29<p>You should have received a copy of the GNU General Public License along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</p>
30<p>This release of icite consists of the following source files:</p>
31<ul>
32<li><p><code>icite.dtx</code></p></li>
33<li><p><code>icite.ins</code></p></li>
34<li><p><code>Makefile</code></p></li>
35</ul>
36<h2 id="license-applicable-to-the-documentation">License applicable to the documentation</h2>
37<p>Copyright ⓒ 2019 Robert Alessi</p>
38<p>The documentation file <code>icite.pdf</code> that is generated from the <code>icite.dtx</code> source file is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit <a href="http://creativecommons.org/licenses/by-sa/4.0/" class="uri">http://creativecommons.org/licenses/by-sa/4.0/</a> or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</p>
39<h1 id="installation">Installation</h1>
40<ol style="list-style-type: decimal">
41<li><p>Run <code>'latex icite.ins'</code> to produce the <code>icite.sty</code> file;</p></li>
42<li><p>To finish the installation you have to move the <code>icite.sty</code> file into a directory where LaTeX can find them. See the FAQ on <code>texfaq.org</code> at <a href="https://texfaq.org/FAQ-inst-wlcf" class="uri">https://texfaq.org/FAQ-inst-wlcf</a> for more on this.</p></li>
43</ol>
44<h1 id="development-git-repository">Development, Git Repository</h1>
45<h2 id="browse-the-code">Browse the code</h2>
46<p>You can browse icite repository on the web: <a href="http://git.robertalessi.net/icite" class="uri">http://git.robertalessi.net/icite</a></p>
47<p>From this page, you can download all the releases of <code>icite</code>. For instructions on how to install <code>icite</code>, please see above.</p>
48<h2 id="comments-feature-requests-bug-reports">Comments, Feature requests, Bug Reports</h2>
49<p><a href="https://gitlab.com/ralessi/icite/issues" class="uri">https://gitlab.com/ralessi/icite/issues</a></p>
50<h2 id="download-the-repository">Download the repository</h2>
51<p><code>icite</code> development is facilitated by git, a distributed version control system. You will need to install git (most GNU/Linux distributions package it in their repositories).</p>
52<p>Use this command to download the repository</p>
53<pre><code>git clone http://git.robertalessi.net/icite</code></pre>
54<p>A new directory named icite will have been created, containing <code>icite</code>.</p>
55<h2 id="git-hosting">Git hosting</h2>
56<p>Make an account on <a href="https://gitlab.com" class="uri">https://gitlab.com</a> and navigate (while logged in) to <a href="https://gitlab.com/ralessi/icite" class="uri">https://gitlab.com/ralessi/icite</a>. Click <em>Fork</em> and you will have in your account your own repository of <code>icite</code> where you will be able to make whatever changes you like to.</p>
57</body>
58</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-06 15:56:08 +0000