Commit Graph

45 Commits

Author SHA1 Message Date
Chris Lane
8d65424ffb README edit
Modified the README with regards to the environment variable changes
made in #294.
2016-11-27 08:54:33 -05:00
Viren Mohindra
6dd8faf26a trivial readme.md correction
availble -> available
2016-03-18 03:23:30 -05:00
Chris Lane
c0aad062ec Trivial README edit. 2016-02-18 15:40:18 -05:00
Chris Lane
8ffeaa4211 README edits
- Replaced the broken PyPi badges with new ones
- Moved some content out of the README and into new wiki pages
- Applied syntax highlighting to shell examples
- Trivial content edits
2016-02-18 15:35:17 -05:00
Shadab Zafar
d897a8a8ea Add a golang version to the Related Projects list 2015-05-19 22:40:24 +05:30
Chris Lane
f9f1c5b3e4 Issue #175
Noted `tldr` as a closely-related project in the `README`.
2014-08-06 22:04:19 -04:00
Chris Lane
191a5e6e84 Trivial changes on jedahan/patch-1 2014-06-22 17:17:27 -04:00
Jonathan Dahan
95636f5433 Add homebrew install instructions to readme
Could close https://github.com/chrisallenlane/cheat/issues/167 , thanks @xu-cheng for making the formula
2014-06-09 00:49:19 -04:00
Chris Lane
eda53cccd6 Minor tweaks on PR #163
- Backed out Windows-related work in `setup.py`, because it is still
  in-progress

- Minor changes to the `README`
2014-06-03 22:34:50 -04:00
Charley Peng
9cd4bdd6d7 Merge branch 'master' of github.com:chid/cheat 2014-05-30 12:18:43 +10:00
Charley Peng
b77b9e8541 Update README.md 2014-05-29 12:01:25 +10:00
Charley Peng
d68fb456ba Added PyPi Badge
Added Badge
2014-05-29 11:59:40 +10:00
Chris Lane
0a3fd3559c Resolves #160
The `setup.py` script no longer attempts to install files to privileged
system directories. (Previously, it attempted to do this in order to
enable command-line autocompletion.) In lieu of doing this within the
installer directly, I have simply included brief instructions explaining
how to configure this manually.

Version bumped accordingly.
2014-05-28 20:49:56 -04:00
Chris Lane
bc6e9ea8a9 Updated README
Removed some obvious-ness regarding the contributing process.
2014-04-27 11:10:41 -04:00
Chris Lane
e2474ad564 Updated the README. 2014-04-27 10:47:04 -04:00
Chris Lane
f46698b656 Performed a large refactoring
Performed an extensive refactoring on the entire application for the
sake of code-cleanliness.

- Refactored out of an ad-hoc Imperative paradigm into more of a
  functional/declarative paradigm. IMO, this makes the application
  signifcantly easier to understand.

- Moved away from `argparse` and into `docopt` for argument parsing

- Version bump to 2.0.0

- Performed extensive refactoring on the setup.py script. Script should
  install to the system more cleanly now.

- Made minor formatting changes to the --list flag output

- Updated the README

Squashed commit of the following:

commit e5681bd536aa0220cdeb7884cc248db55be408c9
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sat Apr 26 23:30:21 2014 -0400

    Fixed many bugs

    Everything seems to work now, I think.

commit 764ec5950cee958eb1b8333ddfcb6bcd45c28429
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sat Apr 26 21:51:31 2014 -0400

    Restructuring for the sake of setup.py

    Seem to finally have a working install script

commit 5a866c23857b77ec65070dd8023cd734f2b7c242
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sat Apr 26 18:01:11 2014 -0400

    Nits

commit a79954ba5b33d992fa6a32abffb33b161d624e3d
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sat Apr 26 17:53:03 2014 -0400

    Implemented search

commit b570a897e9a12c15affe1a72628deae31836dee2
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sat Apr 26 17:11:27 2014 -0400

    Nits

commit 1a8d85b44457f1b2131b3e8475c5270b5d0899e3
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sat Apr 26 17:02:22 2014 -0400

    Still refactoring across files

    Trying to make the program structure clearer

commit 34dffd6462e492e81ea558e2009a71051b7663c9
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sat Apr 26 16:40:37 2014 -0400

    Breaking app into several files

    This is for the sake of code-cleanliness

commit 4825d678ff5f9817ccbf727ef71e5dea15ff2586
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sat Apr 26 15:55:19 2014 -0400

    Got syntax highlighting working

commit c37d7a626d451bfca3d4a072eb9fed604085170f
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sat Apr 26 15:29:22 2014 -0400

    Reduced verbosity of function names

commit 8e626045186b37dce2480f5af1994ddfa8db79b5
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sat Apr 26 15:24:41 2014 -0400

    Refactored argument passing

    Fewer arguments now need to be passed throughout the app.

commit 807ba814650010b3dd1b59d27400b3fb4fcfede7
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Sat Apr 26 11:40:05 2014 -0400

    Working through the refactor

commit e34e6540d4f8cd727e98aac68289d515a02d5fe6
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Thu Apr 24 20:00:10 2014 -0400

    Got a basic end-to-end refactor working

    Have re-implemented just the most basic functionality in the "cheat2"
    file.
2014-04-26 23:39:19 -04:00
puchrojo
500a205c38 Update README.md
sudo apt-get install python-pip
2013-10-23 17:59:56 +02:00
TiTi
97182d4cf1 Add a troubleshooting section (python 2.6 doesn't comes with the argparse module) 2013-10-08 23:55:25 +02:00
Baptiste Fontaine
d3914c0265 Typo fixed 2013-09-15 01:41:00 +02:00
Chris Lane
78532d804b Fixed a typo in the README. 2013-09-14 12:23:19 -04:00
Chris Lane
f1cdfa6dd9 Updated the README. 2013-09-14 11:35:16 -04:00
Chris Lane
213c7a31e1 Updated the README to describe the -d flag and zsh coordination. 2013-09-07 14:38:13 -04:00
Chris Lane
65c557612e Modified the README. 2013-09-01 13:56:49 -04:00
a-sk
702f043ff4 Add note about DEFAULT_CHEAT_DIR to the README file 2013-08-29 19:19:19 +04:00
Chris Lane
3e7dcc9b43 Updated the README to mention the new create/edit abilities. 2013-08-26 21:05:05 -04:00
Alberto Jacini
1ad972a5cf Marked comments in the example cheatsheet 2013-08-24 17:10:16 +02:00
Chris Lane
7cfaddf935 Gave a shout-out to the 'cheat' RubyGem after it was brought to my attention per issue #22. 2013-08-21 23:35:04 -04:00
Chris Lane
43e66c7747 Trivial changes to the README. 2013-08-21 23:02:58 -04:00
Chris Lane
7138a32c4d Updated the README to include instructions for enabling syntax highlighting. 2013-08-21 23:00:22 -04:00
Louis Taylor
73d9f0c83d Merge https://github.com/chrisallenlane/cheat
Conflicts:
	README.md
	cheat
	install
2013-08-17 02:38:31 +01:00
Louis Taylor
f10c7fd19b Change most of the headers to h1's.
Makes the subheadings in the installation section look less strange.
2013-08-16 09:26:18 +01:00
Louis Taylor
1944c1a351 Add a non-root section to the installation guide. 2013-08-16 09:25:07 +01:00
Chris Lane
6b8c516599 Fixing a minor typo in the REAMDE. 2013-08-15 18:55:59 -04:00
Chris Lane
07bd1953e7 More changes to the README. 2013-08-15 18:55:22 -04:00
Chris Lane
40d18e01dc Updated the README to document the usage of the $CHEATPATH environment variable. 2013-08-15 18:52:32 -04:00
Chris Lane
b8c42a1b64 Updated the README. 2013-08-15 18:38:13 -04:00
Louis Taylor
53b93c00e1 Update readme with setup.py 2013-08-13 11:08:05 +01:00
Chris Lane
b2fe140fdb Updated the README. 2013-08-11 15:57:11 -04:00
Chris Lane
11ef3149cd Trivial change to the README. 2013-08-10 19:08:21 -04:00
Chris Lane
ba48816ba1 Made trivial changes to the README. Added the GPL 3 license. 2013-08-10 19:06:01 -04:00
Chris Lane
fa0843c337 Took a first stab at the README. 2013-08-10 18:56:50 -04:00
Chris Lane
58c01320f8 Trivial changes. 2013-08-10 17:14:16 -04:00
Chris Lane
66166e3dd4 Still writing cheat sheets. Also made trivial changes to the README. 2013-08-09 23:17:22 -04:00
Chris Lane
87f1fe13b6 Cleaned up some python. Added support for subcommands. 2013-07-30 23:33:31 -04:00
Chris Lane
1188238381 Got a working version. 2013-07-30 22:48:07 -04:00