Commit Graph

72 Commits

Author SHA1 Message Date
David Adam
87721049db README: small text improvement
[ci skip]
2018-12-11 21:37:41 +08:00
jacob
35c01bcba2 Fix a capitalization error and add a link
I just submitted a PR to fix a few issues in CONTRIBUTING.MD, so I took
a few minutes too look over README.md as well. This is the only room
for improvement I noticed.
2018-10-03 22:12:10 +08:00
Mahmoud Al-Qudsi
6eb8526159 Remove no-longer-needed CMAKE_BUILD_TYPE comment
An update to `CMakeLists.txt` set the default build type to
`RelWithDebInfo`, so there's no need to tell users to consider appending
`-DCMAKE_BUILD_TYPE=Release` at all.

[skip ci]
2018-10-01 20:21:51 -05:00
David Adam
ad4913fd61 README.md: add optional dependencies for yarn, bower and npm completions 2018-08-21 14:48:32 +08:00
Pavel Sviderski
8f526c0876 add try in browser button to launch fish playground 2018-04-23 12:10:30 -07:00
Mahmoud Al-Qudsi
e6e6c0b625 Update **nix -> *nix (Markdown escaping issue) in readme 2018-03-10 07:20:14 -06:00
Mahmoud Al-Qudsi
b575e120cf Update changelog text, formatting, and dependencies
Closes #4422
2018-03-09 16:03:44 -06:00
Mahmoud Al-Qudsi
db6fd2c570 Document $hostname variable 2018-03-09 15:10:53 -06:00
payasrelekar
3f76cccded Fix a typo 2017-10-22 01:01:59 +02:00
Aaron Gyes
5ae09c37a6 README.md: remove extra backtick 2017-10-14 14:50:31 -07:00
ridiculousfish
a1cf2e5576 Update README.md with CMake build instructions 2017-10-14 13:57:26 -07:00
Mahmoud Al-Qudsi
3604522bf2 Removed gmake disclaimer from BSD build instructions
After cc35241a6e, BSD users can just call
make normally and have it redirect the build/install/test/whatever to
GNU Make.
2017-09-24 15:04:40 -05:00
Mahmoud Al-Qudsi
22a4ead36e Update README to include syntax highlighting
Use bash syntax highlighting to make comments appear in gray
2017-09-24 14:03:25 -05:00
Mahmoud Al-Qudsi
46cf8c6bb7 Make build code snippets copy-and-paste friendly 2017-09-16 15:50:41 -05:00
Mahmoud Al-Qudsi
14e23749a6 Use inline code for paths and commands 2017-09-16 15:47:32 -05:00
David Adam
91a0ba9be5 Revert part of "Revert "Cache math expressions""
56d9134534 contained an LRU cache plus
changes to the documentation; 95162ef19d
reverted both.

This commit re-adds the documentation changes, which are still correct.
2017-09-01 21:55:50 +08:00
ridiculousfish
95162ef19d Revert "Cache math expressions"
This reverts commit 56d9134534.

An LRU cache in the shell for math seems like overkill.
2017-09-01 00:25:40 -07:00
Kurtis Rader
56d9134534 Cache math expressions
This implements an LRU cache of recently seen math expressions. When
executing math inside loops and the like this can provide a 33% decrease
in the time to execute the `math` command.
2017-08-24 12:18:39 -07:00
David Adam
1183505695 README.md: rearrange and rewrite
Closes #2062
2017-08-24 22:55:16 +08:00
Kurtis Rader
d247c121a2 Check-in MuParser source
First step in fixing issue #3157 is to check-in the source code and hook
it into our build system.

The inclusion of the MuParser source adds the MIT License to those that
apply to fish. Update our documentation to reflect that fact.

The MuParser documentation is at
http://beltoforion.de/article.php?a=muparser.  The source was downloaded
from https://github.com/beltoforion/muparser/releases. It is also hosted
on Github, https://github.com/beltoforion/muparser/. I did not download
it from Github because that source contained just a couple of cleanup
changes which don't affect its behavior.
2017-08-23 14:43:45 -07:00
Andrew Toskin
058e23720f Clarify notes on dependency errors, tests, and VCS integration.
An optional feature that suggests you install Python is okay;
core-dumping is not.

The note on tests was about fish development tests, not the `test`
builtin for conditional syntax.

Specifically mention git, hg, and svn in the VCS section.
2017-08-14 18:18:10 -07:00
Andrew Toskin
29494d8546 Clarify dependencies: required vs optional, and build vs runtime.
A first pass at updating the dependency documentation, based on the
discussion in this thread:
https://github.com/fish-shell/fish-shell/issues/2062
2017-08-14 18:18:10 -07:00
Andrew Toskin
146c62c603 getopt isn't used anymore, and getent itself is optional.
getopt doesn't work very well in the BSDs, and getent has plenty of
fallbacks to replace it when it's not available.

<https://github.com/terrycloth/fish-shell/commit/
47a768ceeaef1d702624802d83338edbcc0f377c#commitcomment-23613921>
2017-08-14 18:18:10 -07:00
Andrew Toskin
5356384d0a Really spell out the last of the required UNIX utilities.
Finishing the job started in Pull Request #4301

<https://github.com/fish-shell/fish-shell/pull/4301>

Thanks to @faho for filtering and sorting my giant list of detected
possible commands.

<https://github.com/fish-shell/fish-shell/issues/2062#issuecomment-321788080>
2017-08-14 18:18:10 -07:00
Kevin Ballard
ee6c23e6c2 Extract doc install into a separate target install-doc
This way people who install via Xcode can run `make install-doc` to get
the documentation pages, as Xcode doesn't include them.
2017-05-23 16:57:26 -07:00
David Adam
e92779981f README.md: add gmake caveat to autotools section 2017-05-16 20:22:06 +08:00
David Adam
46d86766c4 README.md: drop which requirement
No longer required following merge of #3945.
2017-05-02 09:26:52 +08:00
Kurtis Rader
765891cc4e clarify where to post questions
We've gotten feedback from the Stackexchange team that too many fish
questions asked on stackoverflow don't really belong there. So clarify
the README to also point users at superuser for questions not related to
fish script.
2017-03-27 17:53:47 -07:00
David Adam
40de253b3a Upgrade git:// and http:// URLs to https://
Work on fish-shell/fish-site#47

[ci skip]
2017-02-17 21:31:44 +08:00
ridiculousfish
0eda4020a2 Update README to describe automake dependency 2016-11-26 14:03:31 -08:00
ridiculousfish
73bd7c51cf Update README to describe C++11 support 2016-11-26 13:16:50 -08:00
Aaron Gyes
8f0ea07eab Nobody really "needs" backports.lzma
Walk these sentences back
2016-08-19 10:22:05 -07:00
Aaron Gyes
b93ac10dda Typo 2016-08-19 10:17:19 -07:00
Aaron Gyes
c99386a375 Few more dependencies
Yeah: `--help` doesn't output anything if `nroff` isn't on the system.
2016-08-19 10:16:21 -07:00
Kalpesh Parmar
f9355a0b86 Add further instuction for chsh (logout) to README (#3251) 2016-07-17 18:46:32 +02:00
Kurtis Rader
1f06e5f0b9 add better support for IWYU and fix things
Remove the "make iwyu" build target. Move the functionality into the
recently introduced lint.fish script. Fix a lot, but not all, of the
include-what-you-use errors. Specifically, it fixes all of the IWYU errors
on my OS X server but only removes some of them on my Ubuntu 14.04 server.

Fixes #2957
2016-04-26 15:02:22 -07:00
Kurtis Rader
8e8b5a6481 augment the guide for contributing
Include information about how to deal with lint warnings and suppress
`clang-format` reformatting of blocks of code.

Move information only relevant to developers from the README.md to the
CONTRIBUTING.md document.

Closes #2901
2016-04-05 19:19:57 -07:00
CharlonTank
ad97a122c9 Update README.md
Add a command that instantly add the fish path to /etc/shells
2016-03-25 15:24:30 -07:00
David Adam
c359d28b21 README updates
[ci skip]
2016-02-26 21:46:48 +08:00
Kurtis Rader
8b67a1b26f make testing on local servers hermetic
I noticed while fixing issue #2702 that the fish program being tested
was sourcing config.fish files outside of the current build. This also
happens when Travis CI runs the tests but isn't an issue there because
of how Travis is configured to execute the tests.

I also noticed that running `make test` was polluting my personal fish
history; which will become a bigger problem if and when the fishd universal
var file is moved from $XDG_CONFIG_HOME to $XDG_DATA_HOME.

This change makes it possible for an individual to run the tests on
their local machine secure in the knowledge that only the config.fish and
related files from their git repository will be used and doing so won't
pollute their personal fish history.

Resolves #469
2016-02-25 17:16:36 -08:00
ridiculousfish
2f5d750393 Remove autoconf and lexicon_filter instructions from OS X build
Most OS X users will not have autoconf or Doxygen installed.
2016-01-30 00:18:11 -08:00
Kurtis Rader
b88e31b3f1 fix several build warnings
This fixes all but one of the warnings documented in issue #2685. The
sole remaining warning is from the

    string split '' abc

example in doc_src/string.txt. That example results in the man page
displaying

    string split {} abc

I leave it to someone else to fix that problem (I'll open an issue
specifically for it since it took some effort to track down the source
of the warning).

Resolves issue #2685.
2016-01-28 19:34:51 -08:00
Fabian Homborg
08edfaeae8 Document gitter channel and SO tag 2016-01-24 14:32:43 +01:00
Tobias Mühl
d6d3977f3d Update README.md
I also needed the autoconf package on my system, so adding it to the general template
2015-12-21 20:36:23 -08:00
Satender Singh Rathore
c9ddad94a9 double quote instead of single quote 2015-12-21 20:32:43 -08:00
Fabian Homborg
ce719a700c Mention /etc/shells in README.md 2015-12-10 13:10:20 +01:00
Peter Dave Hello
3c0902b7e4 Use svg instead of png to get better image quality 2015-01-17 11:42:54 +01:00
David Adam
5b709eb5df README.md: document minimum Doxygen version
[skip ci]
2014-09-12 21:35:20 +08:00
Mark Griffiths
9b79931265 Update configure.ac and README for Doxygen 1.8 2014-09-03 14:43:26 +01:00
Mark Griffiths
14a7118499 Revert 60b9f8d..e4d6eaf
This rolls back to commit 60b9f8db18.
2014-09-03 14:43:26 +01:00