Andrew Toskin
904936789b
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-09 00:51:43 -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
Mark Griffiths
07f8fc7697
Update autoconf and README for Doxygen 1.8
2014-09-03 14:43:25 +01:00
callesg
14cdd24f78
Added better build description closes #70
...
The stuff nedded to build on Ubuntu
2014-07-01 16:08:37 +02:00
Konrad Borowski
5066710e60
Use current version documentation links in README
2014-05-24 14:07:18 +02:00
David Adam
689d0082d8
README.md: document build and runtime dependencies even better.
2014-03-10 10:09:52 +08:00
David Adam
09054a09fa
README.md: document build and runtime dependencies better.
2014-02-06 17:51:18 +08:00
David Adam
01ec55366d
README.md: update build status image
...
(oops!)
2014-02-06 17:09:31 +08:00
David Adam
e908b731ab
.travis.yml: add https://travis-ci.org/ automatic builds
2014-02-05 11:25:59 -08:00
David Adam
afb9401fc7
update URL for nightly builds
2013-10-29 13:20:51 +08:00
Marc Joliet
f4f36e356f
Document the optional dependency to backports.lzma.
2013-10-17 12:12:13 +02:00
David Adam (zanchey)
9921e9e79f
document and enforce Autoconf 2.60 or greater
2013-09-06 10:41:58 +08:00
Konrad Borowski
173fd4fd23
Replace IRC link with WebChat link
...
It seems GitHub doesn't allow irc:// protocol, so replace it with WebChat link.
2013-08-30 18:12:50 +02:00
Konrad Borowski
3a893ff17f
Put an IRC link to README.
2013-08-30 18:10:23 +02:00
Konrad Borowski
097e2030b4
libncursesw5-dev is not needed on Debian
...
I just checked on new Debian installation, and only libncurses5-dev appears to be needed.
2013-08-28 09:35:22 +02:00
Siteshwar Vashisht
92b2c28532
Updated links to documentation in README.md
2013-05-19 23:59:20 +05:30
ridiculousfish
49589e2da0
Added note about how to install ncurses, and what to do on EC2
...
Addresses https://github.com/fish-shell/fish-shell/pull/509
2013-04-14 13:38:56 -07:00
ridiculousfish
9762a8ca1e
Remove xsel from the build
...
https://github.com/fish-shell/fish-shell/issues/633
2013-03-30 00:13:44 -07:00
Siteshwar Vashisht
34f2f77067
Updated 'Contact Us' section in README.md
2013-03-25 01:34:24 +05:30
Siteshwar Vashisht
3bf3c11b0b
Added reference to packages built on OBS repository in README.md
2013-01-20 13:12:10 +05:30
ridiculousfish
2bdb199169
Update OS X build instructions
2012-12-26 21:30:03 -08:00
ridiculousfish
34fab879cb
Fix to xcodebuild
...
https://github.com/fish-shell/fish-shell/issues/229
2012-12-01 13:28:30 -08:00
ridiculousfish
3589554028
Allow setting the prompt from web_config
2012-09-06 01:30:26 -07:00
ridiculousfish
3a940781d9
Replaced README with README.md for github
...
Changed 'root' Xcode target to 'install_tree' to avoid confusion
2012-08-21 02:08:49 -07:00