Commit graph

107 commits

Author SHA1 Message Date
Martin von Zweigbergk
388fb0ffc1 readme: add --locked to cargo install step
Our installation instructions don't currently work with Rust < 1.64
because `clap` updated their MSRV to 1.64, and `cargo install` without
`--locked` bypasses `Cargo.lock` and selects the version of `clap`
that needs Rust 1.64.
2023-01-27 18:42:09 -08:00
Martin von Zweigbergk
7c9c2735ae readme: link to Git Merge 2022 talk for info about Google's plans 2023-01-23 11:10:48 -08:00
Michael Forster
27228ce292 Update MSRV to 1.61
This is needed for compatibility with the sapling dag crate.
2023-01-19 10:29:39 +01:00
David Barnett
6da1ecfba0 Add pkg-config to required Linux dependencies
Without it, cargo started erroring out for me after #970 saying it
couldn't find openssl without pkg-config being installed.
2023-01-05 08:01:34 -06:00
Martin von Zweigbergk
635f5a5cb8 build: don't use vendored OpenSSL by default
I added support for using a vendored OpenSSL in dbadbd68c0. That was
in order to get the musl binary to work. However, it shouldn't be
needed on most platforms, and we've had a few reports of issues caused
by it. Let's disable it by default and enable it specifically when
building the musl binary instead.
2023-01-03 18:57:38 -08:00
Ruben Slabbert
dc26d4db17 fix: update cargo install command in readme to specify jujutsu crate 2023-01-03 16:13:23 -08:00
Tal Pressman
cc40740fa2 Update cargo installation instructions 2022-12-24 02:24:23 +09:00
Ilya Grigoriev
c9706fc0d4 Rename jj touchup to jj diffedit 2022-12-21 08:15:06 -08:00
Herby Gillot
d530b34568 readme: add MacPorts install info
https://ports.macports.org/port/jujutsu/
2022-12-06 20:46:47 -08:00
Martin von Zweigbergk
79267b5492 readme: add some badges
Originally written by @xxxserxxx.
2022-11-30 11:31:24 -08:00
Martin von Zweigbergk
c1a008a0fe readme: avoid using "I" since we're now several people contributing 2022-10-24 10:52:38 -07:00
Martin von Zweigbergk
06b99b2a92 readme: PR workflows no longer require many manual steps
Our readme says that pull request require too many manual steps. I
think that refers to the manual abandoning of merged commits that was
necessary before 57ba9a940976; I think the workflow works reasonably
well these days. So let's avoid scaring away potential new users by
mentioning that old problem.
2022-10-24 10:52:38 -07:00
Martin von Zweigbergk
986fced69e demos: replace asciinema by screenshots
The demos don't need to be animated - the user wouldn't miss anything
if they skipped to the end. So let's just show the full output so the
user can read through it at their own pace. We could use plain text,
but I think the colors are helpful, so I went with screenshots.

Closes #166.
2022-10-21 06:04:31 -07:00
Randall Mason
f6dd25126c Add homebrew on Linux and macOS
This adds directions that will work when
https://github.com/Homebrew/homebrew-core/pull/105986 is merged.  If that is
not merged, we can create a tap and adjust these directions accordingly.
2022-10-17 19:27:12 -05:00
Martin von Zweigbergk
0c8c33df73 readme: update asciinema links
As @huyz noticed, I accidentally lost the undo demo in 0d1bf7cb3b. I
also didn't update the working-copy demo. This patch fixes that by
updating all demos, so we also get the recent styling change from
af145c998ea4..
2022-10-02 21:55:26 -07:00
Yuya Nishihara
c9c3735faf cli: add basic support for 'jj log PATH'
In the current implementation, tree is diffed twice if both PATH and -p
are specified. If this adds significant cost, we'll need to reimplement
it without using a revset abstraction (or maybe adjust revset/graph API.)
2022-09-16 13:02:58 +09:00
Ilya Grigoriev
802125aa3c Reword paragraph about jj and other VCS in README
Fixes two pedantic issues with this paragraph:

* "either" describing more than two things

* I am not an expert, but I suspect that Pijul
  supports "automatic rebase".
2022-09-12 20:12:07 -07:00
Martin von Zweigbergk
cc77a232a1 readme: explain that Rust >= 1.60 is needed
We have `rust-version = "1.60"` in `Cargo.toml`, but Cargo doesn't
check that until after dependency resolution, which fails if you have
an older version (I don't know why).
2022-08-29 17:24:57 -07:00
Martin von Zweigbergk
c83e563879 readme: make link to Discard a button 2022-08-28 14:36:25 -07:00
Martin von Zweigbergk
0d1bf7cb3b cli: disable open commits by default 2022-08-26 23:34:52 -07:00
Martin von Zweigbergk
36354e4fa5 readme: add a pointer to the Discord server 2022-08-18 20:15:35 -07:00
Martin von Zweigbergk
7722223902 readme: clarify in the heading that this is a VCS 2022-08-18 20:15:35 -07:00
Martin von Zweigbergk
9c55d98842 cli: rename jj edit to jj touchup 2022-07-01 08:58:08 +08:00
Tal Pressman
0028c0e295 Update installation instructions
Update installation instructions to only install `jj` (excluding test fakes).
2022-06-28 06:38:16 +08:00
Martin von Zweigbergk
a15192c05b docs: update to use new jj branch syntax 2022-06-09 22:24:46 -07:00
Waleed Khan
aedc23176f docs: add missing . in .jjconfig.toml 2022-05-26 18:59:31 -07:00
Martin von Zweigbergk
0865b1ccff cli: show placeholder text for empty commit message
It can be confusing that some commits (typically the working copy)
don't have a description. Let's show a placeholder text in such cases.

I chose the format to match the "(no email configured)" message we
already have.
2022-05-18 09:16:04 -07:00
Martin von Zweigbergk
71c789f50b cli: make log show only local commits by default
The default log output of showing all commits is not very useful when
contributing to an existing repo. Let's have it default to showing
commits not on any remote branch instead. I think that's the best we
can do since we don't have a configurable main branch yet, and we
don't even have per-repo configuration..

Closes #250.
2022-05-14 11:50:05 -07:00
Martin von Zweigbergk
96849da332 docs: prefer ~/.jjconfig.toml on all platforms
It's much easier to tell users on all platforms to put their config in
`~/.jjconfig.toml` than in a path that varies across the platforms, so
let's do that. It also seems like a less controversial location for
the file.

Closes ##233.
2022-05-10 10:21:22 -07:00
Waleed Khan
ed2b8643f8 docs: update README.md
The intention is to make it easier to jump to the Installation section.
2022-05-02 13:57:10 -07:00
Jason R. Coombs
2d4e653e90 Add hint on including completions with xonsh shell. 2022-04-26 16:31:51 -07:00
Jason R. Coombs
99cce19774 Avoid hard-coding homebrew install prefix. 2022-04-26 16:31:51 -07:00
Jason R. Coombs
c2dbbf434d Minor editorial changes for native backend footnote. 2022-04-26 16:31:51 -07:00
Martin von Zweigbergk
095fb9fef4 config: drop support for ~/.jjconfig
I'm a little hesitant to do this because most tools I'm familiar with
have the config file directly in `~/`. It's also easier to describe
where to put the file if it doesn't vary across platforms. But we're
still early in the project, so let's try it and see if we get any
complaints.
2022-03-23 09:57:42 -07:00
Martin von Zweigbergk
2a76572653 docs: add pointer to pre-built binary releases (#73)
Users now have the option of installing from source or directly
installing a binary.

I also corrected some text that effectively said that installing a Nix
flake is not installing from source, but I think it actually does
install from source.
2022-03-16 22:57:38 -07:00
Martin von Zweigbergk
630f8069d0 docs: explain that the there's no reason to use the native backend
A few people in different forums asked if there's any reason to use
the native backend and what the reason for its existance is, so let's
document that.
2022-03-09 07:48:31 -08:00
Martin von Zweigbergk
fbd376df43 docs: mention that libssl-dev and openssl are needed for installation
Closes #75.
2022-03-02 18:38:36 -08:00
Martin von Zweigbergk
78dadcc1ba docs: restructure installation instructions to be per platform
The only overlap between the instructions for Linux, Mac, and Windows
is the `cargo install` step, so let's instead split it up so it's easy
for the user to skip to the relevant part, especially as we add more
platform-specific instructions.

I promoted some sections to one level higher sections to try to
clarify that the initial configuration and the command-line completion
applies to all platforms.
2022-03-02 18:38:36 -08:00
Martin von Zweigbergk
e11e373427 docs: describe how to set up completion for each shell
Setting up completion is particularly non-obvious for Zsh, so let's
provide the exact command(s) for each supported shell.

Closes #67.
2022-02-28 19:35:06 -08:00
Martin von Zweigbergk
70811669fc docs: remove $ from shell scripts for easy copy&paste 2022-02-28 19:35:06 -08:00
Martin von Zweigbergk
1978a7d038 docs: use stable Rust toolchain for installation
We don't need the nightly toolchain anymore since #70 (thanks,
@arxanas!).
2022-02-27 12:49:00 -08:00
Martin von Zweigbergk
1a0b5b9c9e docs: mention user-specific config path on different platforms
Since #85, we load the user's config from a path under
`dirs::config_dir()`. It's probably not obvious to all users where to
put the file, so let's describe that. (I didn't know where to put the
file on my Mac until I looked at the function's documentation.)
2022-02-27 11:48:45 -08:00
Cole Mickens
fbe8eb47db lib/settings: try to load from platform config_dir 2022-02-26 00:09:34 -08:00
Jelle Besseling
9fb580b6ee
Add nix installation instructions 2022-02-20 22:53:04 +01:00
Martin von Zweigbergk
f4cadff6e1 README: description additional installation steps for Mac
I'm not sure which steps are needed and what they depend on (I didn't
need the `pkg-config` bits), so the steps are a little vague for now.

Closes #62.
2022-02-19 23:23:58 -08:00
Martin von Zweigbergk
4a0bd07e8c README: add note about use of libgit2 C library
Closes #56.
2022-02-19 22:55:48 -08:00
Martin von Zweigbergk
819ad475f5 docs: give Google credit for letting this be my 20% project
This has been my 20% for at least a year (dedicating most of my
Wednesdays to it), so let's give Google some credit for that in the
README.
2022-02-08 09:59:28 -08:00
Martin von Zweigbergk
8fe21b0438 docs: mention history rewriting as a feature in README
I think we have better support rewriting history than most other tools
do, so it seems worth mentioning.
2022-01-28 23:07:52 -08:00
Martin von Zweigbergk
377741c5c6 docs: make "features" in readme a heading with sub-headings instead of bullets
The list of features outgrew the bullet form a long time ago...
2022-01-28 22:45:55 -08:00
Martin von Zweigbergk
67b731b34a docs: mention concurrency as a feature in README 2022-01-10 13:05:29 -08:00