1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="UTF-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1.0">
6 <title>foocrypt - the simplest crypto library in the world!</title>
7 <link rel="stylesheet" href="sgw.css">
8</head>
9<body>
10
11 <header>
12 <div class="container">
13 <nav>
14 <a href="#">◀ all repos</a> <br />
15 <a href="index.html">index</a> ❘
16 <a href="files.html">files</a> ❘
17 <a href="commits.html">commits</a>
18 </nav>
19 </div>
20 </header>
21
22 <section class="container">
23
24 <div>
25 <h1>foocrypt</h1>
26 <p>the simplest crypto library in the world!</p>
27 <p><code>git clone https://aktsbot.in/repos/foocrypt.git</code></p>
28 </div>
29
30 <div class="files bb bt">
31 <ul>
32 <li><a href="files.html">src/</a></li>
33 <li><a href="files.html">contrib/</a></li>
34 <li><a href="files.html">examples/</a></li>
35 <li><a href="file.html">app.js</a></li>
36 <li><a href="file.html">README.md</a></li>
37 </ul>
38 </div>
39
40 <div class="readme"><pre><code>
41# RepoRat
42
43A static website generator for Git repos written in Ruby.
44
45* Runs in milliseconds for small repos
46* 'About' page displays truncated file list followed by formatted README
47* 'Files' page lists all files with links to file pages
48* 'Commits' page contains simple Git commit log
49* Each human-readable source file has a viewing pages with linkable line numbers
50* Displays common image formats inline Displays common image formats inline Displays common image formats inline Displays common image formats inline
51* Creates bare repo and link for "dumb http" Git cloning
52* Does **not** create pages for individual commit changes, branches, etc.
53
54
55## Usage
56
57Run RepoRat from the root directory of a Git repo.
58
59Example:
60
61 $ cd my_stuff/cool_repo
62 $ reporat.rb3
63 RepoRat generating site for:
64 cool_repo
65 A really neat program.
66 Output complete at '/home/dave/my_repos/cool_repo'
67
68## Configuration
69
70There are enough parameters that taking them at the command line is unweildy.
71
72Therefore, you are **required** to create a config at `~/.config/reporat.conf.rb`.
73
74This is a pure Ruby source file with methods you define.
75
76See the example file in this repo (which happens to be a copy of _my_ current
77configuration):
78
79Note: Please allow RepoRat to create the individual repo directories underneath
80the root output directory so it can determine if the repo is new or if it has
81been processed before.
82
83## Bare repos and "dumb http" cloning
84
85I've taken the unusual tactic of generating a new bare repo inside
86the output directory when it is first created. Each time RepoRat
87is re-run, the bare repo is re-synced with the latest changes and
88the internals are updated to make it work as a clone source.
89
90The bare repo is given the same name with `.git` appended as per convention:
91
92 cool_repo/cool_repo.git
93
94Now the output directory is completely ready to be served as
95static content over a Web server as-is. Git can clone your repo
96from the bare repo path, discovering which files it needs to
97create the clone. No server setup of any kind is needed!
98</code></pre></div>
99
100 </section>
101
102
103 <footer>
104 <div class="container right">
105 <small>sgw | 2026-05-08T20:31:36.568Z</small>
106 </div>
107 </footer>
108
109
110</body>
111</html>