Commit

Author:

Hash:

Timestamp:

+12 -86 +/-4 browse

Kevin Schoon [me@kevinschoon.com]

1da48e1e41cf8184e35bd3a45c149ea64bcb763c

Fri, 17 Oct 2025 12:26:15 +0000 (3 days ago)

cleanup readme and docs
1diff --git a/README.md b/README.md
2index 1e8f856..cc8d314 100644
3--- a/README.md
4+++ b/README.md
5 @@ -1,7 +1,5 @@
6 # 🌄 Ayllu
7
8- [![status-badge](https://ci.ayllu-forge.org/api/badges/1/status.svg)](https://ci.ayllu-forge.org/repos/1)
9-
10 Ayllu is a hyper performant & hackable code forge optimized for single
11 instance deployments. It leverages the distributed nature of [Git](https://git-scm.com)
12 with a variety of standards based integrations.
13 @@ -29,13 +27,13 @@ ever platform you prefer, _eventually_ we will import both platforms into Ayllu.
14
15 ### Tickets
16
17- [codeberg](https://codeberg.org/ayllu/ayllu/issues)
18- [sourcehut](https://todo.sr.ht/~kevinschoon/ayllu)
19+ * [codeberg](https://codeberg.org/ayllu/ayllu/issues)
20+ * [sourcehut](https://todo.sr.ht/~kevinschoon/ayllu)
21
22 ### Patches
23
24- [codeberg](https://codeberg.org/ayllu/ayllu/pulls)
25- [sourcehut](mailto://~kevinschoon/ayllu-dev@lists.sr.ht)
26+ * [codeberg](https://codeberg.org/ayllu/ayllu/pulls)
27+ * [sourcehut](mailto://~kevinschoon/ayllu-dev@lists.sr.ht)
28
29 ### Chat
30
31 @@ -69,25 +67,13 @@ A general development channel `#ayllu` is available on [libera](ircs://irc.liber
32 | mailing list support | WIP | |
33 | xmpp integration | WIP | |
34 | activity pub based federation | TBD | |
35- | continuous integration | TODO | |
36+ | continuous integration | WIP | |
37 | programmatic access | TODO | |
38 | centralized "hub" | TODO | |
39
40- ## Demo
41-
42- If you'd like to run a simple demo of Ayllu you can serve a local repository with our latest container
43- image.
44-
45- ```sh
46- # change to the repository you'd like to serve
47- cd hello-world
48- podman run --rm -ti -p 10000:10000 -v $PWD:/repo --workdir /repo registry.ayllu-forge.org/ayllu/ayllu:main
49- # Your repository should now be available at http://127.0.0.1:10000
50- ```
51-
52 ## Installation
53
54- See the installation section in the [documentation](/docs/installation.md)
55+ See the installation section in the [documentation](/docs/installation.md).
56
57 ## Compiling From Source
58
59 @@ -107,9 +93,7 @@ script to verify you have all the necessary software on your system.
60 # check your build dependencies
61 scripts/check_build_dependencies.sh
62 # intialize the sqlite database
63- scripts/init_db_if_missing.sh
64- # install pico css
65- npm install
66+ scripts/ensure_database.sh
67 # build the project
68 cargo build
69 ```
70 diff --git a/docs/builds.md b/docs/builds.md
71index 03c789f..8e99984 100644
72--- a/docs/builds.md
73+++ b/docs/builds.md
74 @@ -1,46 +1,3 @@
75- Ayllu contains a plugin called `ayllu-build` which is responsible for executing
76- build manifests in a CI/CD environment. The design of the build system prioritizes
77- the ability to run the entire workflow locally.
78+ # ayllu-build
79
80- ### An Example Local Workflow
81-
82- Build manifests are written in [Nickel](https://nickel-lang.org/).
83-
84- ```sh
85- mkdir -p my-test-repo/.ayllu/build
86- cd my-test-repo && git init
87- # create a simple workflow that prints "Hello" and "World"
88- cat <<EOF > .ayllu/build/main.ncl
89- {
90- workflows = [
91- {
92- name = "Simple",
93- steps = [
94- {
95- name = "Hello",
96- input = "echo -n Hello"
97- },
98- {
99- name = "World",
100- input = "echo -n World"
101- }
102- ]
103- }
104- ]
105- }
106- EOF
107- # validate the build plan and generate a DOT file to stdout
108- ayllu_build plan
109- >>> 2023-12-14T21:58:37.777493Z INFO ayllu_build:66: logger initialized
110- >>> digraph {
111- >>> 0 [ label = "Workflow: Simple" ]
112- >>> 1 [ label = "Step: Hello" ]
113- >>> 2 [ label = "Step: World" ]
114- >>> 0 -> 1 [ label = "0" ]
115- >>> 0 -> 2 [ label = "0" ]
116- >>> }
117- # if you have graphviz installed you can visualize this output:
118- ayllu_build plan | dot -Tx11
119- # finally you can execute the workflow locally
120- ayllu_build evaluate
121- ```
122+ TODO
123 diff --git a/docs/installation.md b/docs/installation.md
124index be316b6..cd2ee4f 100644
125--- a/docs/installation.md
126+++ b/docs/installation.md
127 @@ -1,5 +1,7 @@
128 # Running as a Container
129
130+ *NOTE: The container registry is currently non-functioning, sorry.*
131+
132 The quickest way to get started running Ayllu is by using a container.
133 [Podman](https://podman.io/) is the only supported container platform although
134 Docker may work as well.
135 diff --git a/docs/mail.md b/docs/mail.md
136index ff71ff4..197bd5c 100644
137--- a/docs/mail.md
138+++ b/docs/mail.md
139 @@ -1,20 +1,3 @@
140 # Mailing List Support
141
142- Ayllu has full featured support for email based development workflows. It is
143- based on the excellent [mailpot](https://git.meli-email.org/meli/mailpot)
144- mailing list manager.
145-
146- ## Configuration
147-
148- The configuration of mail servers can be complex. Ayllu encapsulates most of
149- these settings in the [mutliuser](https://ayllu-forge.org/ayllu/ayllu/tree/main/containers/multiuser)
150- container which can be used as a reference for configuring your own mail server.
151-
152- ### Minimum Recommended Security Settings
153-
154- #### DKIM
155-
156- #### SPF Validation
157-
158- The container provides SPF validation and the recommended DNS configuration for
159- a single host e.g. `ayllu-forge.org` is `"v=spf1 a mx ~all"`.
160+ TODO