Commit Graph

49 Commits

Author SHA1 Message Date
Pika
2346c30fec
Add Scoop package to README
type: documentation
2021-05-02 22:26:27 -07: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
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
f832605d81
Document benchmarks in readme
type: documentation
2020-05-26 13:56:42 -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
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
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
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
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
Matt Boulanger
1f8023d13a
Fix directory link in README 2020-04-15 16:37:51 -07:00
Casey Rodarmor
6185d6c8a2
Add table of packages to readme
type: documentation
pr: https://github.com/casey/intermodal/pull/372
fixes:
- https://github.com/casey/intermodal/issues/369
2020-04-11 17:27:47 -07:00
Casey Rodarmor
a67eb72848
Improve install.sh and documentation
- Don't fail now that archive contains directory
- Change default install location to `~/bin`
- Suggestion installing in ~/bin
- Add instructions to create `~/bin`, install there, and add `~/bin` to
  the PATH variable.

type: distribution
pr: https://github.com/casey/intermodal/pull/352
2020-04-09 20:48:43 -07:00
Casey Rodarmor
52b78b90f6
Improve badges
- Make discord badge purple
- Add book badge
- Give crate badge rust logo

type: documentation
pr: https://github.com/casey/intermodal/pull/350
2020-04-09 18:36:26 -07:00
Casey Rodarmor
9d43fa4275
Fix link to rodarmor's PGP key in readme
type: documentation
2020-04-07 19:01:42 -07:00
Casey Rodarmor
543524b96d
Mention signature policy in readme
Document signature policy in readme. This will require changing the
workflow for merging commits, to avoid polluting the commit history with
signatures by a GitHub-controlled key.

type: documentation
2020-04-07 19:01:42 -07:00
Casey Rodarmor
57e482f4b3
Record demo for readme
Uses a crate in `bin/demo` to output a demo script of commands, with a
per-character and per-line delay, and a dummy prompt. Capture output
and render to a gif.

type: documentation
2020-04-07 19:01:38 -07:00
Casey Rodarmor
8c30205b02
Add shell completion scripts
Shell completion scripts can be generated for `bash`, `elvish`, `fish`,
`powershell`, and `zsh` with the `completions` subcommand:

    $ imdl completions --shell zsh > imdl.zsh

The same scripts are available in the `completions` directory. Please
refer to your shell's documentation for more information on how to
install and use completion scripts.

type: added
2020-04-07 19:01:37 -07:00
Casey Rodarmor
6996d1a3ea
List supported OSs in readme
type: documentation
2020-04-07 19:01:33 -07:00
Casey Rodarmor
4f7eead16a
Link to blog post in readme
type: documentation
2020-04-07 19:01:33 -07:00
Casey Rodarmor
89e97144e9
Improve readme intro
type: documentation
2020-04-07 19:01:31 -07:00
Casey Rodarmor
e91b419af5
Improve book
- Write introduction
- Move large readme sections into book
- Rename docs to www

type: documentation
2020-04-07 19:01:30 -07:00
Casey Rodarmor
901fa150ff
Indicate BEP 9 support in readme
type: documentation
2020-04-07 19:01:28 -07:00
Casey Rodarmor
0b486cc681
Update BEP list in readme with new issue links
type: documentation
2020-04-07 19:01:27 -07:00
Casey Rodarmor
f8e3fd594b
Add explanation paragraph to readme
type: documentation
2020-04-07 19:01:26 -07:00
Casey Rodarmor
fdb18bb8d8
Update discord invite link
type: documentation
2020-04-07 19:01:06 -07:00
Casey Rodarmor
55f2fcc738
Add discord badge to readme
type: documentation
2020-04-07 19:01:06 -07:00
Casey Rodarmor
355f76b86d
Update badges
- Add crates.io badge
- Make build badge link to actions page

type: documentation
2020-04-07 19:01:06 -07:00
Casey Rodarmor
b0962722c7
Add Github Actions build badge to readme
Also change the name of the main workflow from Main to Build, since I'd
like the badge to say "Build | Passing".

type: documentation
2020-04-07 19:01:06 -07:00
Casey Rodarmor
165a7ea444
Support adding DHT bootstrap nodes to created torrents
The --dht-node flag can be used to add DHT bootstrap nodes to new torrents.

This is the only piece of metainfo-related functionality in BEP 5, so we can mark BEP
5 as implemented.

type: added
2020-04-07 19:01:05 -07:00
Casey Rodarmor
99a069a021
Add imdl torrent show
The `imdl torrent show` command displays information about on-disk
torrent files. The formatting of the command's output is copied from
torf, an excellent command-line torrent creator, editor, and viewer.

type: added
2020-04-07 19:01:02 -07:00
Casey Rodarmor
85f02d9f29
Add pyrocore to prior art section of readme
Pyrocore is an extensive suite of both general bittorrent and rtorrent
specific tools.

type: documentation
2020-04-07 19:01:02 -07:00
Casey Rodarmor
e2c1f29160
Center symbols in BEP support table key in readme
type: documentation
2020-04-07 19:01:01 -07:00
Casey Rodarmor
48ca86c67c
Add Alternatives & Prior Art section to readme
type: documentation
2020-04-07 19:01:00 -07:00
Casey Rodarmor
ef5be39f9b
Update install instructions to new domain
Install script location is now https://imdl.io/install.sh

type: distribution
2020-04-07 19:01:00 -07:00
Casey Rodarmor
e2cf93efb0
Add install script and installation section to readme
type: distribution
2020-04-07 19:00:59 -07:00
Casey Rodarmor
495316e821
Add table of references to readme
type: documentation
2020-04-07 19:00:59 -07:00
Casey Rodarmor
a8446c82db
Test UDP tracker URLs parse
Also change UDP tracker protocol extensions from unsupported to N/A.

type: testing
2020-04-07 19:00:59 -07:00
Casey Rodarmor
0560181a09
Remove redundant information from the readme
The removed information was added to help messages, so it was redundant.

type: documentation
2020-04-07 19:00:59 -07:00
Casey Rodarmor
1a20f0d0b3
Link to tracking issues from BEP support table
type: documentation
2020-04-07 19:00:58 -07:00
Casey Rodarmor
801a519265
BEP 3 is supported
type: documentation
2020-04-07 19:00:51 -07:00
Casey Rodarmor
1f5b829742
Add table of contents to readme
type: documentation
2020-04-07 19:00:48 -07:00
Casey Rodarmor
66d44155f0
Add BEP support table to readme
Also adds `bin/bin/generate-bep-table.rs`, which generates and updates
the table from a collection of BEPs.

type: documentation
2020-04-07 19:00:48 -07:00
Casey Rodarmor
d1f8f24d8e
Add colored output
Colored output can be controlled on the command line with
`--use-color auto|always|never`. The default is `auto`, which enables
color if `imdl` detects that it is printing to a terminal.

Color can be disabled entirely by setting the `NO_COLOR` environment
variable.

type: added
2020-04-07 19:00:47 -07:00
Casey Rodarmor
98335f435d
Initial commit
type: added
2020-04-07 18:55:30 -07:00