瀏覽代碼

Added Markdown README.md using pandoc

Add centered content and cleanup some of the headings
Update to full documentation placement
Reword the README
Benjamin Gleitzman 3 年之前
父節點
當前提交
4c1f2e10d9
共有 3 個文件被更改,包括 194 次插入232 次删除
  1. 193 0
      README.md
  2. 0 231
      README.rst
  3. 1 1
      docs/index.md

+ 193 - 0
README.md

@@ -0,0 +1,193 @@
+<p align="center">
+    <a href="https://pypi.python.org/pypi/howdoi">
+        <img src="http://sublimate.org/flyers/HowDoIcolor512.png" alt="Sherlock, your neighborhood command-line sloth sleuth" />
+    </a>
+</p>
+<h1 align="center">howdoi</h1>
+<h2 align="center">Instant coding answers via the command line</h2>
+<p align="center"><strong>⚡ Never open your browser to look for help again ⚡</strong></p>
+
+<p align="center">
+    <a href="https://github.com/gleitz/howdoi/actions?query=workflow%3A%22Python+CI%22"><img src="https://img.shields.io/github/workflow/status/gleitz/howdoi/Python%20CI?style=plastic&color=78dce8" alt="build status"></a>
+    <a href="https://pepy.tech/project/howdoi"><img src="https://img.shields.io/badge/dynamic/json?style=plastic&color=ab9df2&maxAge=86400&label=downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fprojects%2Fhowdoi" alt="downloads"></a>
+    <a href="https://pypi.python.org/pypi/howdoi"><img src="https://img.shields.io/pypi/pyversions/howdoi.svg?style=plastic&color=ff6188" alt="Python versions"></a>
+</p>
+
+------------------------------------------------------------------------
+
+## Introduction to howdoi
+
+Are you a hack programmer? Do you find yourself constantly Googling for
+how to do basic programming tasks?
+
+Suppose you want to know how to format a date in bash. Why open your
+browser and read through blogs (risking major distraction) when you can
+simply stay in the console and ask howdoi:
+
+    $ howdoi format date bash
+    > DATE=`date +%Y-%m-%d`
+
+howdoi will answer all sorts of queries:
+
+    $ howdoi print stack trace python
+    > import traceback
+    >
+    > try:
+    >     1/0
+    > except:
+    >     print '>>> traceback <<<'
+    >     traceback.print_exc()
+    >     print '>>> end of traceback <<<'
+    > traceback.print_exc()
+
+    $ howdoi convert mp4 to animated gif
+    > video=/path/to/video.avi
+    > outdir=/path/to/output.gif
+    > mplayer "$video" \
+    >         -ao null \
+    >         -ss "00:01:00" \  # starting point
+    >         -endpos 10 \ # duration in second
+    >         -vo gif89a:fps=13:output=$outdir \
+    >         -vf scale=240:180
+
+    $ howdoi create tar archive
+    > tar -cf backup.tar --exclude "www/subf3" www
+
+[![image](http://imgs.xkcd.com/comics/tar.png)](https://xkcd.com/1168/)
+
+## Installation
+
+    pip install howdoi
+
+## Usage
+
+### New to howdoi?
+
+    howdoi howdoi
+
+### RTFM
+
+-   [Introduction and
+    installation](http://gleitz.github.io/howdoi/introduction/)
+-   [Usage](http://gleitz.github.io/howdoi/usage/)
+-   [Contributing to
+    howdoi](http://gleitz.github.io/howdoi/contributing_to_howdoi/)
+-   [Advanced
+    usage](http://gleitz.github.io/howdoi/howdoi_advanced_usage/)
+-   [Troubleshooting](http://gleitz.github.io/howdoi/troubleshooting/)
+
+### Commands
+
+    usage: howdoi [-h] [-p POS] [-n NUM] [-a] [-l] [-c] [-x] [-C] [-j] [-v] [-e [ENGINE]]
+    [--save] [--view] [--remove] [--empty] [QUERY ...]
+
+    instant coding answers via the command line
+
+    positional arguments:
+      QUERY                 the question to answer
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      -p POS, --pos POS     select answer in specified position (default: 1)
+      -n NUM, --num NUM     number of answers to return (default: 1)
+      -a, --all             display the full text of the answer
+      -l, --link            display only the answer link
+      -c, --color           enable colorized output
+      -x, --explain         explain how answer was chosen
+      -C, --clear-cache     clear the cache
+      -j, --json            return answers in raw json format
+      -v, --version         display the current version of howdoi
+      -e [ENGINE], --engine [ENGINE]
+                            search engine for this query (google, bing, duckduckgo)
+      --save, --stash       stash a howdoi answer
+      --view                view your stash
+      --remove              remove an entry in your stash
+      --empty               empty your stash
+
+    environment variable examples:
+      HOWDOI_COLORIZE=1
+      HOWDOI_DISABLE_CACHE=1
+      HOWDOI_DISABLE_SSL=1
+      HOWDOI_SEARCH_ENGINE=google
+      HOWDOI_URL=serverfault.com
+
+Using the howdoi stashing feature (for more advanced features view the
+[keep documentation](https://github.com/OrkoHunter/keep)).
+
+    stashing: howdoi --save QUERY
+    viewing:  howdoi --view
+    removing: howdoi --remove (will be prompted which answer to delete)
+    emptying: howdoi --empty (empties entire stash, will be prompted to confirm)
+
+As a shortcut, if you commonly use the same parameters each time and
+don\'t want to type them, add something similar to your .bash_profile
+(or otherwise). This example gives you 5 colored results each time.
+
+    alias h='function hdi(){ howdoi $* -c -n 5; }; hdi'
+
+And then to run it from the command line simply type:
+
+    $ h format date bash
+
+You can also search other [StackExchange
+properties](https://stackexchange.com/sites#traffic) for answers:
+
+    HOWDOI_URL=cooking.stackexchange.com howdoi make pesto
+
+or as an alias:
+
+    alias hcook='function hcook(){ HOWDOI_URL=cooking.stackexchange.com howdoi $* ; }; hcook'
+    hcook make pesto
+
+Other useful aliases:
+
+    alias hless='function hdi(){ howdoi $* -c | less --raw-control-chars --quit-if-one-screen --no-init; }; hdi'
+
+## Contributors
+
+-   Benjamin Gleitzman ([\@gleitz](http://twitter.com/gleitz))
+-   Yanlam Ko ([\@YKo20010](https://github.com/YKo20010))
+-   Diana Arreola ([\@diarreola](https://github.com/diarreola))
+-   Eyitayo Ogunbiyi ([\@tayoogunbiyi](https://github.com/tayoogunbiyi))
+-   Chris Nguyen ([\@chrisngyn](https://github.com/chrisngyn))
+-   Shageldi Ovezov ([\@ovezovs](https://github.com/chrisngyn))
+-   Mwiza Simbeye
+    ([\@mwizasimbeye11](https://github.com/mwizasimbeye11))
+-   Shantanu Verma ([\@SaurusXI](https://github.com/SaurusXI))
+-   Sheza Munir ([\@ShezaMunir](https://github.com/ShezaMunir))
+-   Jyoti Bisht ([\@joeyouss](https://github.com/joeyouss))
+-   And [more!](https://github.com/gleitz/howdoi/graphs/contributors)
+
+## How to contribute
+
+We welcome contributions that make howdoi better and improve the
+existing functionalities of the project. We have created a separate
+[guide to contributing to
+howdoi](http://gleitz.github.io/howdoi/contributing_to_howdoi/) that explains
+how to get up and running with your first pull request.
+
+## Notes
+
+-   Works with Python 3.5 and newer. Unfortunately Python 2.7 support
+    has been discontinued :(
+-   There is a [GUI that wraps
+    howdoi](https://pypi.org/project/pysimplegui-howdoi/)
+-   There is a [Flask webapp that wraps
+    howdoi](https://howdoi.maxbridgland.com)
+-   An [Alfred Workflow](http://blog.gleitzman.com/post/48539944559/howdoi-alfred-even-more-instant-answers)
+    for howdoi
+-   Slack integration available through
+    [slack-howdoi](https://github.com/ellisonleao/slack-howdoi)
+-   Telegram integration available through
+    [howdoi-telegram](https://github.com/aahnik/howdoi-telegram)
+-   Special thanks to Rich Jones
+    ([\@miserlou](https://github.com/miserlou)) for the idea
+-   More thanks to [Ben Bronstein](https://benbronstein.com/) for the
+    logo
+
+## Visual Studio Code Extension Installation
+
+howdoi can be installed as an extension on VSCode.
+
+Head over to the [MarketPlace](https://marketplace.visualstudio.com/items?itemName=howdoi-org.howdoi)
+to install the extension.

+ 0 - 231
README.rst

@@ -1,231 +0,0 @@
-howdoi
-======
-
-instant coding answers via the command line
--------------------------------------------
-
-.. image:: https://img.shields.io/github/workflow/status/gleitz/howdoi/Python%20CI?style=plastic&color=78dce8
-        :target: https://github.com/gleitz/howdoi/actions?query=workflow%3A%22Python+CI%22
-
-.. image:: https://img.shields.io/badge/dynamic/json?style=plastic&color=ab9df2&maxAge=86400&label=downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fprojects%2Fhowdoi
-        :target: https://pepy.tech/project/howdoi
-
-.. image:: https://img.shields.io/pypi/pyversions/howdoi.svg?style=plastic&color=ff6188
-        :target: https://pypi.python.org/pypi/howdoi
-
-|
-
-.. image:: http://sublimate.org/flyers/HowDoIcolor512.png
-        :target: https://pypi.python.org/pypi/howdoi
-        :alt: Sherlock, your neighborhood command-line sloth sleuth
-
-Sherlock, your neighborhood command-line sloth sleuth.
-
-----
-
-
-`howdoi documentation <http://gleitz.github.io/howdoi/>`_
-~~~~~~~~~~~~~~~~~
-
--  `Introduction to howdoi and installation <http://gleitz.github.io/howdoi/introduction/>`_
--  `Howdoi usage <http://gleitz.github.io/howdoi/usage/>`_
--  `Setting up the development environment <http://gleitz.github.io/howdoi/development_env/>`_
--  `Contributing to howdoi <http://gleitz.github.io/howdoi/contributing_to_howdoi/>`_
--  `Contributing documentation to howdoi <http://gleitz.github.io/howdoi/contributing_docs/>`_
--  `Extension development <http://gleitz.github.io/howdoi/extension_dev/>`_
--  `howdoi advanced usage <http://gleitz.github.io/howdoi/howdoi_advanced_usage/>`_
--  `Troubleshooting <http://gleitz.github.io/howdoi/troubleshooting/>`_
--  `Development environment for windows <http://gleitz.github.io/howdoi/windows-contributing/>`_
-
-INTRODUCTION TO HOWDOI
-----------------------
-
-Are you a hack programmer? Do you find yourself constantly Googling for
-how to do basic programming tasks?
-
-Suppose you want to know how to format a date in bash. Why open your browser
-and read through blogs (risking major distraction) when you can simply stay
-in the console and ask howdoi:
-
-::
-
-    $ howdoi format date bash
-    > DATE=`date +%Y-%m-%d`
-
-howdoi will answer all sorts of queries:
-
-::
-
-    $ howdoi print stack trace python
-    > import traceback
-    >
-    > try:
-    >     1/0
-    > except:
-    >     print '>>> traceback <<<'
-    >     traceback.print_exc()
-    >     print '>>> end of traceback <<<'
-    > traceback.print_exc()
-
-    $ howdoi convert mp4 to animated gif
-    > video=/path/to/video.avi
-    > outdir=/path/to/output.gif
-    > mplayer "$video" \
-    >         -ao null \
-    >         -ss "00:01:00" \  # starting point
-    >         -endpos 10 \ # duration in second
-    >         -vo gif89a:fps=13:output=$outdir \
-    >         -vf scale=240:180
-
-    $ howdoi create tar archive
-    > tar -cf backup.tar --exclude "www/subf3" www
-
-.. image:: http://imgs.xkcd.com/comics/tar.png
-        :target: https://xkcd.com/1168/
-
-Installation
-------------
-
-::
-
-    pip install howdoi
-
-or
-
-Check out howdoi docs for more ways of `installation <http://gleitz.github.io/howdoi/introduction/>`_
-
-New to howdoi?
---------------
-
-::
-
-    howdoi howdoi
-
-Usage
------
-
-::
-
-    usage: howdoi [-h] [-p POS] [-n NUM] [-a] [-l] [-c] [-x] [-C] [-j] [-v] [-e [ENGINE]] [--save] [--view] [--remove] [--empty] [QUERY ...]
-
-    instant coding answers via the command line
-
-    positional arguments:
-      QUERY                 the question to answer
-
-    optional arguments:
-      -h, --help            show this help message and exit
-      -p POS, --pos POS     select answer in specified position (default: 1)
-      -n NUM, --num NUM     number of answers to return (default: 1)
-      -a, --all             display the full text of the answer
-      -l, --link            display only the answer link
-      -c, --color           enable colorized output
-      -x, --explain         explain how answer was chosen
-      -C, --clear-cache     clear the cache
-      -j, --json            return answers in raw json format
-      -v, --version         display the current version of howdoi
-      -e [ENGINE], --engine [ENGINE]
-                            search engine for this query (google, bing, duckduckgo)
-      --save, --stash       stash a howdoi answer
-      --view                view your stash
-      --remove              remove an entry in your stash
-      --empty               empty your stash
-
-    environment variable examples:
-      HOWDOI_COLORIZE=1
-      HOWDOI_DISABLE_CACHE=1
-      HOWDOI_DISABLE_SSL=1
-      HOWDOI_SEARCH_ENGINE=google
-      HOWDOI_URL=serverfault.com
-
-Using the howdoi stashing feature (for more advanced features view the `keep documentation <https://github.com/OrkoHunter/keep>`_).
-
-::
-
-    stashing: howdoi --save QUERY
-    viewing:  howdoi --view
-    removing: howdoi --remove (will be prompted which answer to delete)
-    emptying: howdoi --empty (empties entire stash, will be prompted to confirm)
-
-As a shortcut, if you commonly use the same parameters each time and don't want to type them, add something similar to your .bash_profile (or otherwise). This example gives you 5 colored results each time.
-
-::
-
-    alias h='function hdi(){ howdoi $* -c -n 5; }; hdi'
-
-And then to run it from the command line simply type:
-
-::
-
-    $ h format date bash
-
-You can also search other `StackExchange properties <https://stackexchange.com/sites#traffic>`_ for answers:
-
-::
-
-    HOWDOI_URL=cooking.stackexchange.com howdoi make pesto
-
-or as an alias:
-
-::
-
-    alias hcook='function hcook(){ HOWDOI_URL=cooking.stackexchange.com howdoi $* ; }; hcook'
-    hcook make pesto
-
-Other useful aliases:
-
-::
-
-    alias hless='function hdi(){ howdoi $* -c | less --raw-control-chars --quit-if-one-screen --no-init; }; hdi'
-
-Contributors
-------------
-
--  Benjamin Gleitzman (`@gleitz <http://twitter.com/gleitz>`_)
--  Yanlam Ko (`@YKo20010 <https://github.com/YKo20010>`_)
--  Diana Arreola (`@diarreola <https://github.com/diarreola>`_)
--  Eyitayo Ogunbiyi (`@tayoogunbiyi <https://github.com/tayoogunbiyi>`_)
--  Chris Nguyen (`@chrisngyn <https://github.com/chrisngyn>`_)
--  Shageldi Ovezov (`@ovezovs <https://github.com/chrisngyn>`_)
--  Mwiza Simbeye (`@mwizasimbeye11 <https://github.com/mwizasimbeye11>`_)
--  Shantanu Verma (`@SaurusXI <https://github.com/SaurusXI>`_)
--  Sheza Munir (`@ShezaMunir <https://github.com/ShezaMunir>`_)
--  Jyoti Bisht (`@joeyouss <https://github.com/joeyouss>`_)
--  And `more! <https://github.com/gleitz/howdoi/graphs/contributors>`_
-
-HOW TO CONTRIBUTE
------------------
-
-We welcome contributions that make Howdoi better and/or improve the existing functionalities of the project. We have created a separate `guide to contributing to howdoi <http://gleitz.github.io/howdoi/contributing_to_howdoi/>`_ which resides in the howdoi documentation in mkdcos. 
-The guide contains the following:
-
-- Introduction for first time contributors 
-- Getting started with howdoi 
-- Making PRs and testing 
-- Asking for help 
-- Helpful tips for a good contribution experience.
-
-Notes
------
-
--  Works with Python 3.5 and newer. Unfortunately Python 2.7 support has been discontinued :(
--  There is a `GUI that wraps howdoi <https://pypi.org/project/pysimplegui-howdoi/>`_.
--  There is a `Flask webapp that wraps howdoi <https://howdoi.maxbridgland.com>`_.
--  An Alfred Workflow for howdoi can be found at `http://blog.gleitzman.com/post/48539944559/howdoi-alfred-even-more-instant-answers <http://blog.gleitzman.com/post/48539944559/howdoi-alfred-even-more-instant-answers>`_.
--  Slack integration available through `slack-howdoi <https://github.com/ellisonleao/slack-howdoi>`_.
--  Telegram integration available through `howdoi-telegram <https://github.com/aahnik/howdoi-telegram>`_.
--  Special thanks to Rich Jones (`@miserlou <https://github.com/miserlou>`_) for the idea.
--  More thanks to `Ben Bronstein <https://benbronstein.com/>`_ for the logo.
-
-Visual Studio Code Extension Installation
------------------------------------------
-
-howdoi can now be installed as an extension on Visual Studio Code! There are two ways to install it:
-
-1.  On the Visual Studio Code MarketPlace:
-
-   -  Head over to the `MarketPlace <https://marketplace.visualstudio.com/items?itemName=howdoi-org.howdoi>`_ to install the extension.
-
-2.  Directly from the packaged extension:
-
-   -  Head over `here <https://github.com/gleitz/howdoi/tree/master/extension/vscode-pkg/README.md>`_ to locally install the howdoi Visual Studio Code package.

+ 1 - 1
docs/index.md

@@ -1,5 +1,5 @@
 # howdoi
-Never open your browser to look for answers again.
+Never open your browser to look for help again.
 
 Create tar archive:
 ```bash