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
Martin von Zweigbergk
037d66965d
docs: start documenting Git compatibility
2022-01-03 22:40:58 -08:00
Martin von Zweigbergk
93250fe6c8
docs: link from README to post about rebase speed
...
For now, the best documentation we have of how fast `jj` is is the
GitHub discussion about rebase speed.
2022-01-03 21:36:56 -08:00
Martin von Zweigbergk
f9e6b263a1
docs: explain how not exposing "the index" in the UI is a good thing
2021-12-18 09:22:35 -08:00
Martin von Zweigbergk
71b0233efb
docs: add doc about a first-class conflicts
2021-12-18 08:07:28 -08:00
Martin von Zweigbergk
ef4dbf216f
docs: add links from README to detailed docs
2021-12-18 08:01:47 -08:00
Martin von Zweigbergk
423a894cba
docs: consistently use hyphens in filenames
2021-12-18 07:56:48 -08:00
Martin von Zweigbergk
4c71c763e9
docs: document revsets ( #46 )
...
Now that revset operators are not as embarrassing as before, let's
document them.
2021-12-15 16:56:45 -08:00
Martin von Zweigbergk
6b0a568e44
docs: add pointer from README to Git-comparison doc
2021-11-18 22:06:15 -08:00
Martin von Zweigbergk
9375106a05
cli: use same color for timestamps in operation log as in commit log
2021-11-07 21:41:22 -08:00
Martin von Zweigbergk
798b4bc897
demos: add demo showing how conflicting commits can be rebased etc
2021-11-07 15:17:51 -08:00
Martin von Zweigbergk
bf64f89521
demos: update conflict-resolution demo with recent changes
...
Conflicts are now preserved in the working copy until their conflict
markers are gone (they used to be considered resolved).
2021-11-07 15:17:51 -08:00
Martin von Zweigbergk
d37e484fc8
docs: explain what the tool is about, not why I started it
2021-10-28 15:01:19 -07:00
Martin von Zweigbergk
c293638028
docs: add more detail about the project status (like what's missing)
2021-10-28 15:01:19 -07:00
Martin von Zweigbergk
5c0e929b29
docs: add a "Related Work" section to README
2021-10-28 15:01:19 -07:00
Martin von Zweigbergk
98337e819d
demos: add more jj log calls to the working-copy demo
...
Thanks to @arxanas for the suggestion.
2021-10-27 21:16:29 -07:00
Martin von Zweigbergk
4f8632519b
docs: update demo links with recent changes
2021-10-27 18:12:21 -07:00
Martin von Zweigbergk
3c6a922b97
docs: don't hide demos in collapsed regions in the README
2021-10-27 16:09:05 -07:00
Martin von Zweigbergk
a3a13f8bbf
demos: update demo recordings with stable graph edge ordering
2021-10-23 20:45:51 -07:00
Martin von Zweigbergk
5acd360e86
demos: update conflict-resolution demo link to a lower-resolution version
...
I forgot to make my terminal window smaller before recording the
previous version.
2021-10-23 14:48:08 -07:00
Martin von Zweigbergk
c661181e08
demos: add demo of basic conflict resolution
2021-10-23 14:40:33 -07:00
Martin von Zweigbergk
97612f9e99
demos: add demo of the operation log
2021-10-22 23:52:16 -07:00
Martin von Zweigbergk
74e21acd02
demos: add demo of automatic working copy commit
2021-10-22 21:59:07 -07:00
Martin von Zweigbergk
2dd0bf7b12
demos: type faster, pause more
...
I find it frustrating to wait for the typing, but I need much more
time to think between commands (and users who are new to the tool
surely need even more time).
2021-10-22 18:36:00 -07:00
Martin von Zweigbergk
234cb15ff8
demos: add automated demo of cloning Git repo
...
The automation is mostly copied from
https://github.com/arxanas/git-branchless/tree/master/demos , so big
thanks to @arxanas for writing that!
2021-10-22 13:56:30 -07:00
Martin von Zweigbergk
ca796b49f0
docs: describe how to set up commmand-line completion
2021-10-13 20:45:55 -07:00
Martin von Zweigbergk
56e0f1254b
docs: move initial configuration from tutorial to README
...
It seems better to have all the one-time setup in the README.
2021-10-13 20:37:48 -07:00
Martin von Zweigbergk
8fef1c2068
docs: move installation instructions from tutorial to README
...
I also changed the instructions to use `cargo install --git` pointing
straight to GitHub, so we don't have the naming conflict with the jj
repo created in the tutorial.
2021-10-13 08:52:40 -07:00
Martin von Zweigbergk
0e3b4b406a
README: remove the empty "Future plans" section
...
This section has always been empty (IIRC). I think we'll use GitHub
issues for tracking remaining work instead.
2021-10-13 08:44:29 -07:00
Martin von Zweigbergk
f33117b2f8
README: update to describe "automatic rebase" instead of evolution ( #32 )
2021-10-03 12:01:14 -07:00
Martin von Zweigbergk
880d469b5f
readme: fix typoed "tutorial"
2021-09-20 09:02:40 -07:00
Martin von Zweigbergk
4aa1fd7cbb
docs: move tutorial from README.md to docs/tutorial.md
2021-09-09 11:10:40 -07:00
Martin von Zweigbergk
77662c0674
readme: add "Status" section and stop saying it's not ready for use
...
I have been using the tool myself for 7-8 months now, and the UX has
improved substantially, so I think it's ready for use.
2021-09-08 10:40:13 -07:00
Martin von Zweigbergk
538bec22ff
tutorial: clarify that rustup install nightly doesn't change the default
2021-09-01 08:08:18 -07:00
Martin von Zweigbergk
f13f15e057
cli: add jj rebase -s and make jj rebase -r rebase descendants onto parents
...
I think it makes sense to have a version of rebase that rebases the
descendants of the rebased commit onto the parents of the rebased
commit. Let's make `jj rebase -r` do just that. Let's also add `jj
rebase -s` (matching Mercurial's `hg rebase -s`) for rebasing a commit
and its descendants onto another commit.
Since both flavors of the command now explicitly rebase the
descendants (just to different destinations), I also made the command
not evolve orphans afterwards. That would have made sense regardless
of this commit.
2021-08-28 10:01:00 -07:00
Martin von Zweigbergk
52678237a7
cli: after cloning git repo, update to remote's HEAD
2021-08-25 21:42:32 -07:00
