Commit Graph

144 Commits

Author SHA1 Message Date
Martin von Zweigbergk
0525dc9d86 politics: delete references to Pijul
The Pijul maintainer has opinions that I don't understand about how we
mention Pijul (they consider the current mentions offensive as
"bashing Pijul"). Let's just remove the references so we don't have to
deal with it. I think the references to Darcs we already had in most
of these places are sufficient.
2024-04-14 13:16:08 -07:00
Steve Klabnik
e699e9da93 Fix link to my tutorial
2d62f22de1 reorganized some things, and so this link became broken
2024-03-20 14:56:28 -05:00
Chris Krycho
1ec6a8f92d Add @chriskrycho's YouTube series to the README 2024-03-19 10:42:14 -06:00
Martin von Zweigbergk
e9655dba13 move: deprecate the command
Per discussion in
https://github.com/martinvonz/jj/discussions/2882. `jj squash` now has
all the functionality.
2024-03-11 09:25:17 -07:00
Philip Metzger
e9fc8d4e40 Readme: Add a related media section and tidy up the news a bit.
This bundles all Jujutsu related media (the talk, its slides and the three articles we were featured in) 
into a section.

Also update the news section to mention the recent deprecations and the three articles we recently 
were featured in. 

Thanks to everyone who wrote one.
2024-02-15 20:04:37 +01:00
Austin Seipp
91d1205d55 readme: fix [!WARNING] section
Apparently this previously-beta markdown syntax from GitHub "graduated" to a
full feature in such a way that it it actually regressed in features, so doing
this `[!WARNING]` inline inside of a list is no longer valid. Sigh. Scoot it
up a level in the document, and just make it part of the section and not inside
the list.

Signed-off-by: Austin Seipp <aseipp@pobox.com>
2024-02-08 16:59:55 -06:00
Ikko Eltociear Ashimine
96efc1224f docs: update README.md
minor fix.
2024-02-04 10:12:48 -06:00
Austin Seipp
889f052dfa readme: do some cleanup
As noted by Martin and Waleed on Discord.

Signed-off-by: Austin Seipp <aseipp@pobox.com>
Change-Id: I9cba734774a7e89dfd65c8202e76c2f4
2023-12-21 16:26:17 -06:00
Ilya Grigoriev
07fda2cec1 README: Fix a typo (extraneous word) 2023-11-23 13:57:37 -08:00
mlcui
7269365a0d readme: Add Discord badge to the top of document
A coworker was having trouble finding a link to the jj Discord community. Add it to the top of the document, alongside the other badges, so it's easier to find.
2023-11-14 10:22:22 +11:00
Austin Seipp
56ba801478 readme: improved frontmatter, part 2
Summary: What was going to just be some minor touch-ups to the existing content
ended in another rework of the frontmatter, this time primarily the sales pitch
and basic feature explanation.

The motivation here is simple: you should not just encounter a three-word noun
that is a hyperlink to pages with 1,000 words actually explaining the three-word
noun itself is. It's jarring!

Instead, the frontmatter is longer, expanding on each major selling point and
similarity to other tools. It actually *describes* the important, distinct
design decisions that tell you what the tool is and does, rather than just link
you around a bunch.

For example, one immediate thing is that calling jj a "DVCS" is actually kind
of odd when it later becomes apparent that you can have multiple data model and
commit backends; Google for example uses it in a more centralized manner than
others would via Piper/CitC. Calling it a "DVCS" is a bit strange in this sense
when *really* what we mean is that the Git data model allows independent copies
of the repo.

Overall I think this is *much* better for people who are just going to see the
README and may or may not bounce off immediately.

Signed-off-by: Austin Seipp <aseipp@pobox.com>
Change-Id: I9f0f78e56157ef434ec239710e00f3bd
2023-11-05 12:34:21 -06:00
Ilya Grigoriev
f81c724822 README.md: "quite" -> "fairly" feature complete
This makes a one-word change suggested in
https://discord.com/channels/968932220549103686/968932220549103689/1160641833349689464

Thanks to @solson for the idea.
2023-10-08 21:29:04 -07:00
Austin Seipp
b66adb4bb7 readme: tidy up the front matter a little
Summary: Reintroduce 4acdf726 without spurious formatted changes. (This means I
don't have to go back over things with a fine comb.)

Signed-off-by: Austin Seipp <aseipp@pobox.com>
Change-Id: I18ec68722362a2a64b99a368d3f25cf5
2023-10-07 16:35:06 -05:00
Austin Seipp
706c5026f6 backout of commit 4acdf72601 2023-10-07 16:35:06 -05:00
Austin Seipp
4acdf72601 readme: tidy up the front matter a little
Summary: Just a small rework of the very top-level frontmatter. Now:

- Uses `<div>` to center things a little
- Adds top-level links to the new homepage, installation guide, and tutorial
- Reworks the disclaimer and 'Introduction' section. After all, a README should
first say what the project is! I think this reads much better.

Signed-off-by: Austin Seipp <aseipp@pobox.com>
Change-Id: I2d92a21650afec0640add3741d4f20c5
2023-10-07 16:11:33 -05:00
Ilya Grigoriev
fd80dcd5ed README: Edits to Getting Started
The link to the glossary was weirdly far from the link to the FAQ.

Also, added a mention of the prerelease docs.
2023-09-11 18:22:56 -07:00
Ilya Grigoriev
eee3d488f1 README: point users to the new documentation website 2023-09-11 18:22:56 -07:00
Ilya Grigoriev
18bcc87794 docs: make co-located repos more prominent, more details
At this point, they are stable enough that I think we should
advertise them and encourage their use. This also explains
some caveats.
2023-09-06 09:15:27 -07:00
Ilya Grigoriev
64140c34b7 docs: Move installation instructions from README to docs/
This allows the tutorial to reference them and will make it
easier to have different instructions for different versions.

We can later restore some instructions to the README, but I
think this is important since the installation instructions
do change in important (even if slight) ways from time to
time.
2023-08-28 10:43:48 -07:00
Ben Saunders
e563d60e64 Update docs and errors to use XDG config path 2023-08-11 13:21:44 -07:00
Philip Metzger
8188dc42df Docs: Add a FAQ
This answers some questions, which were repeatedly asked in Discord.
2023-08-09 01:19:55 +02:00
Martin von Zweigbergk
d1b3a0a3e3 readme: fix typo (fix adopted from #1942) 2023-08-03 22:10:01 +00:00
Martin von Zweigbergk
b6c65c12ac readme: clarify that snapshotting doesn't result in a chain of commits
It's not clear at all right now that snapshotting the working copy
results in it being amended.
2023-08-02 21:13:46 +00:00
Martin von Zweigbergk
82be7f727c readme: format with IntelliJ
This makes it easier for me to make further changes. Hopefully it
won't make it harder for others.
2023-08-02 21:13:46 +00:00
Martin von Zweigbergk
6ee8feea86 docs: clarify that GitHub discussions are fine (not only Discord)
Someone on HN (justifiably) seemed to think that we only accept
questions on Discord.
2023-08-02 13:49:02 +00:00
Martin Clausen
c696d7c62f Correct typo 2023-08-01 20:42:30 +00:00
Martin von Zweigbergk
8149ec6df6 release: release version 0.8.0
Thanks to everyone who's contributed!
2023-07-16 21:40:24 +01:00
Martin von Zweigbergk
aac5b7aa25 cargo: rename crates from jujutsu/jujutsu-lib to jj-cli/jj-lib
Almost everyone calls the project "jj", and there seeems to be
consensus that we should rename the crates. I originally wanted the
crates to be called `jj` and `jj-lib`, but `jj` was already
taken. `jj-cli` is probably at least as good for it anyway.

Once we've published a 0.8.0 under the new names, we'll release 0.7.1
versions under the old names with pointers to the new crates names.
2023-07-09 06:40:43 +02:00
Martin von Zweigbergk
033b287e54 README: rewrite sections about the working-copy commit and repo-first design
I tried to clarify the benefits of these two features (#1708).
2023-06-20 16:00:21 +02:00
Martin von Zweigbergk
dc98a56119 README: put jj debug completion (jj<=0.7.0) close to jj debug version
Fixes #1711.
2023-06-20 13:20:14 +02:00
Ilya Grigoriev
d13db728ba README: Delete the section on the rust version
We'll rely on `cargo` informing users instead. The previously confusing
error is hopefully obsolete.
2023-06-13 12:50:47 -07:00
Martin von Zweigbergk
41a2855b4f README: add some pointers to the glossary 2023-04-28 11:02:28 -07:00
Martin von Zweigbergk
92a911b7a3 cli: rename jj support to jj util
I wasn't quite happy with `jj support` but I couldn't think of
anything better when I moved the commands from `jj debug` in
e2b4d7058d. Thanks to @ilyagr for suggesting `jj util`.
2023-04-12 21:34:47 -07:00
Martin von Zweigbergk
4e60e69208 readme: remove pointer to closed issue about native backend 2023-03-24 11:42:41 -07:00
Martin von Zweigbergk
8f1dc49039 cargo: upgrade to clap 4.1
This includes some changes to error messages. Also, the Zsh shell
completion script is now simpler to source.

Fixes #1393.
2023-03-17 22:44:29 -07:00
Martin von Zweigbergk
e2b4d7058d cli: move some debug commands to new (non-hidden) support group
The `jj debug` commands are hidden from help and are described as
"Low-level commands not intended for users", but e.g. `jj debug
completion` is intended for users, and should be visible in the help
output.
2023-03-17 06:50:55 -07:00
Martin von Zweigbergk
e5a4c2e75b readme: don't say that this is my 20% project
The project has been my full-time project since around last summer, so
it's incorrect to say that it's my 20% project.
2023-03-09 16:41:54 -08:00
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