Casey Rodarmor
bf29d74b3e
Add changelog to book
...
Add the changelog to the book. It's no longer comitted, so it's good to
have the current version available somewhere.
type: documentation
2020-04-30 00:22:43 -07:00
Casey Rodarmor
60a72cf057
Add color to bin/gen error messages
...
type: development
2020-04-29 22:58:07 -07:00
Casey Rodarmor
8dfdbe43df
Add bin/gen command to diff generated content
...
The following command will print a diff between HEAD and HEAD^:
cargo run --package gen diff
type: development
2020-04-29 22:46:32 -07:00
Casey Rodarmor
342266853e
Improve bin/gen error messages
...
Create an error enum with actual error messages.
type: development
2020-04-29 00:36:25 -07:00
Casey Rodarmor
d077da405e
Improve documentation
...
- Document the various ways files can be included and excluded from
torrents in the book.
- Make links to the book more prominent in the readme, by including them
in sections with obvious names.
type: documentation
2020-04-24 23:32:24 -07:00
Casey Rodarmor
c75ec39b14
Remove watch dropdown image from readme
...
It's big and ugly and doesn't add much.
type: documentation
2020-04-23 15:27:35 -07:00
Casey Rodarmor
8fbe39726f
Add notes for packagers to readme
...
type: documentation
2020-04-23 14:59:49 -07:00
Casey Rodarmor
43788cac9a
Fix bin/package
...
Also, To more easily test the `bin/package` script, build and publish
packages for all tags, not just those that start with `v`.
type: fixed
2020-04-23 01:20:24 -07:00
Casey Rodarmor
28114c3d64
Don't commit shell completion scripts
...
Committing the completion scripts bloats diffs, so stop committing them.
Before copying release files, generate the scripts in `bin/package`.
type: development
2020-04-21 00:29:26 -07:00
Casey Rodarmor
838167c4d3
Describe in FAQ creating torrent from git repo
...
type: documentation
2020-04-20 20:10:26 -07:00
Casey Rodarmor
9f48062461
Improve FAQ template
...
Use separate anchor tags, so FAQ entry titles are properly rendered.
type: documentation
2020-04-20 00:17:57 -07:00
Casey Rodarmor
1cb1178672
Create FAQ
...
Add an FAQ section to the book. Include information about how to use
imdl with `fzf --preview`.
type: documentation
fixes:
- https://github.com/casey/intermodal/issues/397
2020-04-19 23:19:29 -07:00
Casey Rodarmor
70dbe93c6a
Note install script only works on Linux and MacOS
...
Unfortunately, the install script doesn't work on windows, due to:
- Powershell defining an alias that maps `curl` to `Invoke-WebRequest`,
which is incompatible with `curl`.
- The absence of the `rev` command.
type: documentation
fixes:
- https://github.com/casey/intermodal/issues/371
2020-04-19 19:56:54 -07:00
Casey Rodarmor
09b0ee316c
Document piece length selection algorithm
...
Add a page to the book discussing factors in piece length selection, and
Intermodal's piece length selection algorithm.
type: documentation
pr: https://github.com/casey/intermodal/pull/392
fixes:
- https://github.com/casey/intermodal/issues/367
2020-04-18 23:12:31 -07:00
Casey Rodarmor
3ed449ce93
Generate reference sections with bin/gen
...
type: documentation
2020-04-18 19:14:54 -07:00
Casey Rodarmor
0a754d0bcf
Add manual Arch install link
...
Add a link to the arch wiki for manual installation from AUR.
type: documentation
fixes:
- https://github.com/casey/intermodal/issues/373
2020-04-18 13:33:09 -07:00
Casey Rodarmor
9098d36840
Readme improvements
...
- Mention various chat channels
- Add `intermodal-bin` package to package table
- Document `bin/gen`
- Add contributing section
- Link to book
type: documentation
2020-04-17 23:28:08 -07:00
Casey Rodarmor
04338e3501
Merge documentation and changelog generation
...
Merge documentation generation into a single binary, `bin/gen`. This
includes: The changelog, man pages, the readme, and the book.
type: reform
2020-04-17 21:31:54 -07:00
