Commit graph

48 commits

Author SHA1 Message Date
Fabian Boehm
2d2f18c159 installable builds: Fail when building man pages fails
This is unfortunately necessary, because otherwise it would not rerun
the build script just because you installed sphinx.

Because we use the man pages for --help output, they're pretty
necessary.

To override it, you can set $FISH_BUILD_DOCS=0, like

```fish
FISH_BUILD_DOCS=0 cargo install --path .
```
2024-12-11 16:49:49 +01:00
David Adam
c58313fb2b README: minor formatting update 2024-12-11 08:04:52 +08:00
David Adam
662607fb2a README: minor formatting update 2024-12-11 08:04:15 +08:00
David Adam
6ae887383c README: improve instructions on building from source
Closes #10894.
2024-12-11 08:04:00 +08:00
Fabian Boehm
fcf8ed0628 Clarify docs on self-installing builds 2024-12-07 13:13:18 +01:00
Fabian Boehm
74e0436c3c Document installable builds 2024-12-06 22:12:26 +01:00
David Adam
7f29f09d25 README: updates for Rust / 4.0 2024-11-06 23:22:26 +08:00
Fabian Boehm
61bf839991 Update README 2024-06-12 08:11:16 +02:00
Fabian Boehm
b5624f2e81 README: Update deps even more
I think we can now call what we have in git better than the last
C++-based release, and you'll still need a C compiler to build it
because we still have some C code (libc.c).
2024-05-02 19:44:43 +02:00
David Adam
a9078769c3 Update dependencies since RIIR is completed 2024-05-02 00:00:26 +08:00
Fabian Boehm
16fcc5de7c Increase MSRV to 1.70
It appears we can't find a system that ships rustc >= 1.67 and < 1.70,
so keeping it at 1.67 gains nothing.

1.70 is used in Debian 13, so that will be able to build fish out of
the box (12 was on 1.63 which was already too low).
2024-04-29 22:00:59 +02:00
Johannes Altmanninger
da94ade2ad README: fix rst syntax 2024-04-26 11:16:30 +02:00
Fabian Boehm
f62f1aaf99 Remove remaining mentions of curses 2024-02-23 16:36:10 +01:00
Johannes Altmanninger
47aa79813d Open command script in external editor on Alt+o
Fish functions are great for configuring fish but they don't integrate
seamlessly with the rest of the system. For tasks that can run outside fish,
writing scripts is the natural approach.

To edit my scripts I frequently run

    $EDITOR (which my-script)

Would be great to reduce the amount typing for this common case (the names
of editor and scripts are usually short, so that's a lot of typing spent on
the boring part).

Our Alt+o binding opens the file at the cursor in a pager.  When the cursor
is in command position, it doesn't do anything (unless the command is actually
a valid file path). Let's make it open the resolved file path in an editor.

In future, we should teach this binding to delegate to "funced" upon seeing
a function instead of a script. I didn't do it yet because funced prints
messages, so it will mess with the commandline rendering if used from
a binding.  (The fact that funced encourages overwriting functions that
ship with fish is worrysome. Also I'm not sure why funced doesn't open the
function's source file directly (if not sourced from stdin). Persisting the
function should probably be the default.)

Alternative approach: I think other shells expand "=my-script" to
"/path/to/my-script".  That is certainly an option -- if we do that we'd want
to teach fish to complete command names after "=".  Since I don't remember
scenarios where I care about the full path of a script beyond opening it in
my editor, I didn't look further into this.

Closes #10266
2024-02-07 00:07:47 +01:00
Fabian Boehm
84b03c24d5 README: Remove chsh section
This is awkward because some systems really want $SHELL to be
sh-compatible, it's also duplicated with the actual docs and not
really something you have to do in the first five minutes of using
fish.

Supersedes #10229
2024-01-20 11:38:33 +01:00
Abdo Omar
744fa72d9c Update README.rst
windows 10 -> windows 10/11
2024-01-02 22:24:58 +08:00
Fabian Boehm
8c555505c0 README: Remove useless use of echo 2023-12-17 12:50:12 +01:00
David Adam
0f70b2c0d3 README: bump CMake requirements for Rust build
file(real_path) added in 35baa883 requires CMake 3.19.
2023-10-12 15:48:38 +08:00
Fabian Boehm
46de22561a README: Link via matrix, not gitter
Gitter is now just another matrix server, so it's pretty useless and
not as well-known as a service.
2023-09-06 15:48:12 +02:00
Fabian Boehm
4f888d79ee README: Do give the path dynamically in the switching instructions
Apparently this is actually a point of confusion.

Unfortunately we can't use `which` here because 1. it might not be
installed, 2. it might be trash.

So we give instructions from inside fish, and explain that they
should *typically* work.

See #10002
2023-09-05 22:38:47 +02:00
David Adam
09ed315159 README: remove Xcode, minor linting
Closes #9924.
2023-08-04 22:28:11 +08:00
Fabian Boehm
3d7ad4d3f1 README: Update dependencies for riir
Fixes #9893
2023-07-15 10:56:28 +02:00
ridiculousfish
d843b67d2d Initial Rust commit 2023-02-02 19:34:47 -07:00
Fabian Boehm
f7f052ad40 README: Link to fishshell.com instead of the design docs.
First tell people what it is instead
2023-01-09 17:44:27 +01:00
ridiculousfish
0618bb0121 Add cirrus build status README 2022-11-12 15:17:14 -08:00
ridiculousfish
7f204ed64c Update the README to reflect new PCRE2 instructions 2022-07-02 19:00:08 -07:00
Fabian Homborg
df64ba2e40 README: Note the minimum supported macOS version 2022-06-01 19:38:33 +02:00
Fabian Homborg
5af2ead85a README: Remove ul dependency
No longer used
2022-03-26 20:41:45 +01:00
Aaron Gyes
ca6e9f9fe7
README.rst: fix badge
The name of the main workflow changed to "test" a while back, and then "make test" after that.
2021-12-17 16:12:08 -08:00
Fabian Homborg
39a31d273c README: Link to Unix & Linux Stackexchange instead of SO
Stackoverflow's fish tag suffers from inconsistent moderation and an
annoying policy on what is allowed and what isn't.

Given that fish straddles the line between "programming" and "usage",
some fish questions would be allowed and some wouldn't, and it is
awkward for users to tell which.

So stop recommending a site that, in practice, closes user's questions
for unclear reasons.

This needs to be done for fish-site as well.
2021-11-30 22:22:05 +01:00
David Adam
c0fa4a6f4c README: use apt instead of apt-get
apt has a slightly nicer UI.

Fixes #8497.
2021-11-30 21:39:46 +08:00
David Adam
e066715127 README: improve note on colorls 2021-11-16 21:42:07 +08:00
David Adam
210dda2c4c CMake: bump minimum requirement to 3.5
CMake 3.5.0 was released in March 2016.
2021-06-28 23:56:02 +08:00
Fabian Homborg
a9b4ad4b9f README: Document build options 2021-06-06 12:21:44 +02:00
Scott Bonds
3ddb5a2bdc
Add color to ls output on OpenBSD when colorls is installed (#8035)
* add support for colorized ls on openbsd

* add changelog line for colorls support

* add readme line for colorls support

* determine ls command at runtime, don't cache it

* eliminate __fish_ls_command function
2021-06-01 19:46:13 +02:00
Fabian Homborg
2095d744cf README: Remove "try in browser" leftovers
This was missed in 5a53ead240.
2021-04-22 18:25:28 +02:00
Johannes Altmanninger
b3c520cc47 README: link to the Building section 2021-04-17 22:53:34 +02:00
Fabian Homborg
5a53ead240 README: Remove rootnroll
This was removed from fish-site in
7c19bf2cc9a3742346527cd6979671f16b8caeb9 because it's out of date, so
it gives a bad first impression.

In my tests it also loads very slowly and features oh-my-fish instead
of a stock fish.
2021-04-16 15:47:18 +02:00
David Adam
3f08fb9f9e Revert "README: note dependency on tput"
This reverts commit 50398ea9f5.

tput is only required as a fallback for backward compatibility.
2021-03-28 16:15:32 +08:00
David Adam
50398ea9f5 README: note dependency on tput 2021-03-27 23:28:21 +08:00
Johannes Altmanninger
8b0b987993 README: remove redundant mention of sed dependency 2021-02-16 18:39:03 +01:00
Fabian Homborg
d8cf8de99b Remove Travis
Travis is gone.

We have Github Actions set up now, which should be okay.

Fixes #7447.
2020-11-11 20:17:00 +01:00
David Adam
f9505996e7 README/CHANGELOG: make Python requirements consistent
[ci skip]
2020-09-16 15:57:36 +08:00
Fabian Homborg
68ab016267 CHANGELOG/README python 3-ification
Fixes #6537.

[ci skip]
2020-09-11 21:21:04 +02:00
Fabian Homborg
c7efe46e0b README: The gettext command is no longer required
`_` is now a proper builtin, so we don't spuriously call out to gettext.
2020-06-14 19:30:03 +02:00
Fabian Homborg
deb816c91c README: Mention python3 and pexpect for the tests
Technically the script tests could probably be run with 2.7, but the
README doesn't need to be that exhaustive.

[ci skip]
2020-06-14 19:30:03 +02:00
Fabian Homborg
382595e1e9 Update some .md references 2020-05-30 10:07:21 +02:00
Fabian Homborg
e6f5c78d39 Convert Markdown files to RST
We use sphinx with rst for our documentation, and github supports rst
here, so it seems weird to have markdown just for these.

It also allows us e.g. to include the CHANGELOG in the docs without
requiring another build dependency.
2020-05-30 10:07:21 +02:00