tweak project proposal #1

Open
kiara wants to merge 95 commits from rewrite into main
4 changed files with 38 additions and 21 deletions
Showing only changes of commit ac3b9c9c30 - Show all commits

1
.gitignore vendored
View file

@ -1,3 +1,4 @@
result
*.err
*.odt
*.html

View file

@ -1,11 +1,11 @@
# fediversity proposal
# Fediversity project proposal
## usage
Build a PDF:
```sh
nix-shell
pandoc architecture.md -o architecture.html
pandoc architecture.html -o architecture.pdf
pandoc --filter pandoc-include fediversity.md -o fediversity.html
pandoc fediversity.html -o fediversity.pdf
> **Note**
>
> It will take a while to download dependencies!
Review

Seems like the nix-build -A pdf thing got lost in cherry- and nit-picks?

Seems like the `nix-build -A pdf` thing got lost in cherry- and nit-picks?
Review

was it ever tested? on my end it just errored out on images requiring network access, at which point i considered it not usable as-is

was it ever tested? on my end it just errored out on images requiring network access, at which point i considered it not usable as-is
Review

note that the script is present still, at present it's just undocumented

note that the script is present still, at present it's just undocumented
```bash
nix-build -A pdf
```

28
default.nix Normal file
View file

@ -0,0 +1,28 @@
{
pkgs ? import <nixpkgs> { },
}:
{
shell = pkgs.mkShellNoCC {
packages = with pkgs; [
pandoc
pandoc-include
texliveMedium
librsvg
];
};
pdf =
pkgs.runCommand "fediversity"
{
buildInputs = with pkgs; [
pandoc
pandoc-include
texliveMedium
librsvg
];
}
''
mkdir -p $out
pandoc ${./architecture.md} -o $out/architecture.pdf
pandoc --filter pandoc-include ${./fediversity.md} -o $out/fediversity.pdf
'';
}

View file

@ -1,13 +1 @@
{
pkgs ? import <nixpkgs> { },
}:
{
shell = pkgs.mkShellNoCC {
packages = with pkgs; [
pandoc
pandoc-include
texliveMedium
librsvg
];
};
}
(import ./. { }).shell