Commit

Author:

Hash:

Timestamp:

+36 -84 +/-6 browse

Kevin Schoon [me@kevinschoon.com]

a861757cc93bca5b30289313473dbbaf7ff67ac8

Fri, 12 Jun 2026 11:21:47 +0000 (1 month ago)

clean up various documentation, clarify contribution policies
1diff --git a/ATTRIBUTIONS.md b/ATTRIBUTIONS.md
2index c7610e6..187077c 100644
3--- a/ATTRIBUTIONS.md
4+++ b/ATTRIBUTIONS.md
5 @@ -7,11 +7,9 @@ Ayllu would not be possible without many free software projects.
6 ## Many [Rust](https://www.rust-lang.org/) Libraries
7
8 * [axum](https://github.com/tokio-rs/axum)
9- * [sqlx](https://github.com/launchbadge/sqlx/)
10 * [git2-rs](https://github.com/rust-lang/git2-rs)
11 * [tree-sitter](https://github.com/tree-sitter/tree-sitter)
12 * [comrak](https://github.com/kivikakk/comrak)
13- * [tokei](https://github.com/XAMPPRocky/tokei/)
14
15 And many more, see the `Cargo.toml` file.
16
17 diff --git a/Cargo.lock b/Cargo.lock
18index 5a934d9..2fae225 100644
19--- a/Cargo.lock
20+++ b/Cargo.lock
21 @@ -325,17 +325,6 @@ dependencies = [
22 ]
23
24 [[package]]
25- name = "ayllu-init"
26- version = "0.1.0"
27- dependencies = [
28- "ayllu_cmd",
29- "ayllu_git",
30- "ayllu_logging",
31- "nix 0.31.3",
32- "tracing",
33- ]
34-
35- [[package]]
36 name = "ayllu-keys"
37 version = "0.5.1"
38 dependencies = [
39 diff --git a/Cargo.toml b/Cargo.toml
40index 43973e1..3af70e5 100644
41--- a/Cargo.toml
42+++ b/Cargo.toml
43 @@ -16,7 +16,7 @@ members = [
44 "ayllu-keys",
45 "ayllu-migrate",
46 "quipu",
47- "xtask", "ayllu-init",
48+ "xtask",
49 ]
50
51 [workspace.dependencies]
52 diff --git a/README.md b/README.md
53index cc8d314..22243f9 100644
54--- a/README.md
55+++ b/README.md
56 @@ -4,24 +4,20 @@ Ayllu is a hyper performant & hackable code forge optimized for single
57 instance deployments. It leverages the distributed nature of [Git](https://git-scm.com)
58 with a variety of standards based integrations.
59
60- Ayllu might fit the following use cases well:
61+ ## Documentation
62
63- - A drop-in replacement for [gitweb](https://git-scm.com/docs/gitweb) allowing
64- you to browse your repositories locally.
65- - Self-hosted personal project pages with lots of customizability.
66- - Small to medium sized community projects.
67-
68- ## Name
69-
70- The name [Ayllu](https://en.wikipedia.org/wiki/Ayllu) _/ˈajʎu/_, _eye-joo_ is
71- the Quechua word for the traditional form of a community in the Andes region
72- of South America, particularly in Bolivia and Peru.
73+ The majority of Ayllu's documentation is hosted in the man page section on it's
74+ canonical site: [ayllu-forge.org/man](https://ayllu-forge.org/man), if you
75+ already have Ayllu installed then try `man ayllu.7`.
76
77 ## Project Status & Collaboration
78
79- Please note that this is still a work in progress and the project's canonical
80- home is at [ayllu-forge.org](https://ayllu-forge.org). To facilitate collaboration
81- we have mirrors available at [codeberg](https://codeberg.org/ayllu/ayllu) and
82+ Please note that this project is both a work in progress and a labour of love
83+ (sometimes) and as such contributions can be challenging to adopt since the
84+ project is changing rapidly.
85+
86+ To facilitate collaboration we have mirrors available
87+ at [codeberg](https://codeberg.org/ayllu/ayllu) and
88 [sourcehut](https://git.sr.ht/~kevinschoon/ayllu). Please feel free to use which
89 ever platform you prefer, _eventually_ we will import both platforms into Ayllu.
90
91 @@ -35,56 +31,30 @@ ever platform you prefer, _eventually_ we will import both platforms into Ayllu.
92 * [codeberg](https://codeberg.org/ayllu/ayllu/pulls)
93 * [sourcehut](mailto://~kevinschoon/ayllu-dev@lists.sr.ht)
94
95+
96 ### Chat
97
98- A general development channel `#ayllu` is available on [libera](ircs://irc.libera.chat/#ayllu).
99-
100- ## Features
101-
102- | Feature | Status | Notes |
103- | ----------------------------- | ------ | ------------------------------------------------------------------ |
104- | git-log | ✅ | |
105- | git-clone (http & ssh) | ✅ | |
106- | git-notes | ✅ | |
107- | git-blame | ✅ | |
108- | git-lfs | ✅ | |
109- | git-verify | ✅ | |
110- | refs (tags & branches) | ✅ | |
111- | release exporting | ✅ | |
112- | blob rendering | ✅ | |
113- | tree/file browsing | ✅ | |
114- | patch generation | ✅ | |
115- | markdown rendering | ✅ | |
116- | diff generation | ✅ | |
117- | syntax highlighting | ✅ | via [tree-sitter](https://tree-sitter.github.io/tree-sitter/) |
118- | source code analysis | ✅ | |
119- | full featured rss support | ✅ | |
120- | customizable themes | ✅ | |
121- | static hosting | ✅ | |
122- | activity tracking | ✅ | |
123- | extensible plugin system | ✅ | |
124- | WebFinger | ✅ | |
125- | mailing list support | WIP | |
126- | xmpp integration | WIP | |
127- | activity pub based federation | TBD | |
128- | continuous integration | WIP | |
129- | programmatic access | TODO | |
130- | centralized "hub" | TODO | |
131-
132- ## Installation
133-
134- See the installation section in the [documentation](/docs/installation.md).
135+ A general development channel `#ayllu` is available
136+ on [Libera](ircs://irc.libera.chat/#ayllu) and on [Matrix](https://matrix.to/#/#ayllu-dev:matrix.org).
137
138- ## Compiling From Source
139+ ### LLM / AI Policy
140
141- Ayllu is written in [rust](https://www.rust-lang.org/) and you'll need its
142- compiler to build the project. Additionally you also must have the following
143- installed on your system:
144+ LLM / AI contributions are explicitly forbidden, each line of code you
145+ contribute should be written by you OR generated by some kind of deterministic
146+ tooling. If you read the output of something that may have been generated by
147+ an LLM and it looks like what you want to do that's okay but adapt the concept
148+ in your own language and accommodate the local idioms of this project.
149+
150+ ### Code of Conduct
151
152- - [git](https://git-scm.com)
153- - [sqlx-cli](https://github.com/launchbadge/sqlx/tree/main/sqlx-cli)
154- - [libgit2](https://libgit2.org/)
155+ We do not currently have a code of conduct however if/when the need arises to
156+ adopt one it will be one which is characterized by inclusivity, empathy, and
157+ one that encourages the promotion of independent internet communities.
158
159+ ## Compiling From Source
160+
161+ Ayllu is written in [rust](https://www.rust-lang.org/) and you'll need its
162+ compiler to build the project.
163
164 You can run the [check_build_dependencies.sh](https://ayllu-forge.org/ayllu/ayllu/blob/scripts/check_build_dependencies.sh)
165 script to verify you have all the necessary software on your system.
166 diff --git a/scripts/check_build_dependencies.sh b/scripts/check_build_dependencies.sh
167index 5620385..760aa36 100755
168--- a/scripts/check_build_dependencies.sh
169+++ b/scripts/check_build_dependencies.sh
170 @@ -29,15 +29,13 @@ check_library() {
171 }
172
173 check_cmd "cargo"
174- check_cmd "cargo-watch"
175 check_cmd "cc"
176- check_cmd "djlint" # format / lint jinja html templates
177- check_cmd "fc-list" # fontconfig
178+ # check_cmd "djlint" # format / lint jinja html templates
179+ # check_cmd "fc-list" # fontconfig
180 check_cmd "pkg-config"
181- check_cmd "shellcheck"
182- # check_cmd "sqlx"
183- # check_cmd "sqlite3"
184-
185+ # check_cmd "shellcheck"
186+ check_cmd "sqlite3"
187+ check_cmd "diesel"
188 # check for openssl which annoyingly is required to build sqlx-cli if that is
189 # being installed from a non-distribution package i.e. cargo install
190 check_library "openssl"
191 diff --git a/scripts/ensure_database.sh b/scripts/ensure_database.sh
192index 1c77342..eb9bae7 100755
193--- a/scripts/ensure_database.sh
194+++ b/scripts/ensure_database.sh
195 @@ -1,5 +1,5 @@
196 #!/bin/sh
197- set -ex
198+ set -e
199 # initialize a local database for builds and testing assuming the package
200 # has database support.
201
202 @@ -10,8 +10,5 @@ mkdir -p "$(dirname "${DB_PATH}")"
203 echo "$DB_PATH"
204
205 if [ ! -e "${DB_PATH}" ]; then
206- cargo sqlx database create --database-url "${DB_URL}"
207+ diesel migrate up
208 fi
209-
210- cargo sqlx migrate run --source "migrations" --database-url "${DB_URL}"
211- cargo sqlx prepare --workspace