Commit Graph

33 Commits

Author SHA1 Message Date
Pika
2346c30fec
Add Scoop package to README
type: documentation
2021-05-02 22:26:27 -07:00
Casey Rodarmor
452486a782
Placate clippy
type: reform
2021-05-02 22:00:43 -07:00
Casey Rodarmor
61bbd3bad5
Skip generating changelog in tests
Changelog generation requires annotating commits with a commit type,
otherwise the tests will fail. This is annoying for contributors, since
it's unusual, and I often myself forget to do it, causing a round-trip
with tests.

So, skip generating the changelog during the tests. Also, change the
`--no-git` option for `gen book` and `gen all` to `--no-changelog`, so
it's clearer what it does.

I think I'll wind up just making a YAML file that contains commit types,
for changelog generation, so it doesn't have to be done in the commit
message.

type: testing
2021-01-08 22:10:07 -08:00
Pika
05ba87039b
Add Void Linux package to README
type: documentation
2020-10-20 13:35:27 -07:00
Celeo
70c1f4e57c
Center README header items
type: documentation
2020-10-01 19:54:57 -07:00
Casey Rodarmor
39dcb5e183
Don't treat head as special in changelog
The changelog is no longer comitted, so we no longer need to avoid
including the commit hash.

type: documentation
2020-09-06 23:21:01 -07:00
Casey Rodarmor
2d226cf016
Make changelog author more concise
If both author name and email are present for a commit, format as a
link. If one is absent, format as the other. If both are absent, format
as "Anonymous".

type: documentation
2020-09-06 22:54:34 -07:00
Casey Rodarmor
a53c2bc5db
Remove Keybase and IRC links from readme
Keybase and IRC chat never got any users, and since I never check them
and they get no traffic, it's probably best to remove them from the
readme.

type: documentation
2020-06-25 18:48:11 -07:00
Casey Rodarmor
04b58464c9
Add --no-git flag to gen book
Skip generating the changelog for the book when `--no-git` is passed to
`gen book` or `gen all`.

type: added
2020-06-24 03:33:50 -07:00
Casey Rodarmor
047b36639d
Add --no-git flag to gen all
The flag skips steps whichr require a git checkout, currently only the
changelog generator.

type: added
2020-06-23 21:51:13 -07:00
Casey Rodarmor
f832605d81
Document benchmarks in readme
type: documentation
2020-05-26 13:56:42 -07:00
Casey Rodarmor
4e6b475470
Benchmark and improve hashing performance
- Add a `bench` feature that exposes a hasher benchmark.

- Make the hasher read up to the next piece end and hash everything it
  reads, instead of hashing one byte at a time. This was a 4x
  improvement on the benchmark. (Terrible code == easy wins!)

type: performance
2020-05-26 00:15:09 -07:00
Casey Rodarmor
c1c8d3cb89
Move data crate to its own repo
I suspect that the `data` crate will get more review, use, and
contributors if it lives in its own repository, so move it to
casey/data.

type: removed
2020-05-24 05:30:42 -07:00
Casey Rodarmor
f4f7a69069
Add co-authored-by field to commit metadata
This field is used by GitHub to credit co-authors.

type: development
co-authored-by: y7y <pair@rodarmor.com>
2020-05-01 01:28:40 -07:00
Casey Rodarmor
e7872f56f2
Move all output from bin/gen to target/gen
To make it clearer what is and isn't generated content, make gen place
all generated output in `target/gen`.

Also, try to make the readme clearer about the location of build
artifacts.

type: development
2020-05-01 00:29:40 -07:00
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