forked from earthstar-project/willowprotocol.org
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
18385ef
commit 3140c77
Showing
1 changed file
with
13 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# We Are Sorry | ||
|
||
This repository houses a completely undocumented, experimental macro expansion system for generating text documents. It also houses the source of [https://willowprotocol.org/](https://willowprotocol.org/), which augments the undocumented macro expander with a diverse set of undocumented macros, often of abysmal code quality. | ||
|
||
On the bright side, we consider the macro system a success and will eventually create a clean, well-documented, standalone version of it. Until then, unfortunately, the source for the Willow website (including for all the specifications) will stay rather inaccessible. We welcome issues on even the most trivial typo fixes, and will happily take care of them. | ||
|
||
For the brave who do want to venture into the source: | ||
|
||
- The webpages themselves live in the [https://github.com/earthstar-project/tsgen/tree/main/willowtest/specs](https://github.com/earthstar-project/tsgen/tree/main/willowtest/specs) directory, with assets and css residing [one level higher](https://github.com/earthstar-project/tsgen/tree/main/willowtest). | ||
- The entrypoint to rendering the site is [`main.ts`](https://github.com/earthstar-project/tsgen/blob/main/willowtest/main.ts) (not to be confused with the *other* [`main.ts`](https://github.com/earthstar-project/tsgen/blob/main/main.ts) 🫠). | ||
- The macro expander is defined in [`tsgen.ts`](https://github.com/earthstar-project/tsgen/blob/main/tsgen.ts). | ||
|
||
Again, we are sorry, but it is what it is. |