Skip to content

Commit

Permalink
docs: Ads the "Usage" chapter and the demo animation
Browse files Browse the repository at this point in the history
  • Loading branch information
ironcev committed Oct 13, 2017
1 parent 088435d commit 11ccfd7
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 7 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,25 @@ A [Visual Studio Code](https://code.visualstudio.com) extension that teaches you
[![license](https://img.shields.io/github/license/ironcev/without-guns-for-vs-code.svg)]()

## About

*Without Guns* allows you to quickly turn ON and OFF the following widely used Visual Studio Code features:
*Without Guns* allows you to quickly turn ON and OFF the following Visual Studio Code features:
- IntelliSense
- Syntax Highlighting
- Code Lens

When these features are turned OFF, we say that we code "without guns".

Occasional coding without guns forces you to code mindfully and yields the following benefits:
- Increased coding confidence
- Deeper knowledge of programming language syntax and features
- Deeper knowledge of used frameworks and libraries
- **Increased coding confidence**
- **Deeper knowledge of programming language syntax and features**
- **Deeper knowledge of used frameworks and libraries**

I suggest coding without guns whenever you learn something new, being that a new programming language, algorithm, framework or a technology.

## Usage
To start coding without guns simply call the `Guns: Without` command from the Command Palette. To get the guns back, call the `Guns: With` command. An image is worth a thousand words, therefore:

![Without Guns extension in action](https://raw.githubusercontent.com/ironcev/without-guns-for-vs-code/master/images/demo.gif)

## FAQ
### Q: Why is the extension called "Without Guns"? Do you like guns?
No, I don't like guns. On the contrary, I dream of a world without them. The origin of the name is a story of its own :-) It has something to do with a quote from the 1996 film [Last Man Standing](https://en.wikipedia.org/wiki/Last_Man_Standing_(1996_film)) starring [Karina Lombard](https://en.wikipedia.org/wiki/Karina_Lombard), [Bruce Willis](https://en.wikipedia.org/wiki/Bruce_Willis), and [Christopher Walken](https://en.wikipedia.org/wiki/Christopher_Walken). I plan to write a blog post about it. The blog post will also explain the whole philosophy behind the programming without guns.
Expand Down
9 changes: 7 additions & 2 deletions images/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# Images

## Logo
The logo is created in [Inkscape](https://inkscape.org/), a "professional vector graphics editor for Windows, Mac OS X and Linux." Inkscape is free and open source.
The logo is created in [Inkscape](https://inkscape.org/), a professional vector graphics editor for Windows, Mac OS X and Linux. Inkscape is free and open source.

The [Cancel icon](cancel.svg) is made by [Maxim Basinski](https://www.flaticon.com/authors/maxim-basinski).

The [Gun icon](gun.svg) is made by [Smashicons](https://www.flaticon.com/authors/smashicons).

Both icons are available on [flaticon.com](https://www.flaticon.com/) and licensed by [Creative Commons BY 3.0 (CC 3.0 BY)](http://creativecommons.org/licenses/by/3.0/).
Both icons are available on [flaticon.com](https://www.flaticon.com/) and licensed by [Creative Commons BY 3.0 (CC 3.0 BY)](http://creativecommons.org/licenses/by/3.0/).

## Demo
The screen is captured with [CamStudio](http://camstudio.org), a free and open source desktop recorder streaming video software.

The resulting AVI file is converted to animated GIF in [VirtualDub](http://virtualdub.org), a free and open source video capture/processing utility.
Binary file added images/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 11ccfd7

Please sign in to comment.