forked from extern/nix-config
docs: Update READMEs for code, editorconfig, and gpg
This commit is contained in:
parent
6ccf5d3352
commit
f9d9b65ab8
@ -1,25 +1,19 @@
|
||||
# Code
|
||||
|
||||
Code is a GUI text editor.
|
||||
[Code][code] is an open source build of [a popular][vscode] GUI text editor.
|
||||
|
||||
## Dependencies
|
||||
## Use Cases
|
||||
|
||||
- [code][code] - The open source build of a popular non-free text editor
|
||||
Code can be used to:
|
||||
|
||||
## Installation
|
||||
- Navigate graphical file trees entirely with the mouse
|
||||
- Provide an editor for non-vim users as needed
|
||||
- Perform a myriad of common command line operations through a point-click GUI
|
||||
|
||||
```sh
|
||||
make package=code
|
||||
```
|
||||
You should not use Code if:
|
||||
|
||||
## Usage
|
||||
|
||||
Install the extensions I use with:
|
||||
|
||||
```sh
|
||||
make code-extensions
|
||||
```
|
||||
|
||||
Then, start Code as you normally would.
|
||||
- You want to learn how compilers, git, find, grep, and other software work
|
||||
- You want to learn [vim](/vim), the standard text editor
|
||||
|
||||
[code]: https://www.archlinux.org/packages/community/x86_64/code/
|
||||
[vscode]: https://github.com/Microsoft/vscode
|
||||
|
@ -1,19 +1,20 @@
|
||||
# editorconfig
|
||||
|
||||
These are the settings I use for editing files. Spaces or tabs do not matter, since the environment you use should make both behave very similarly if not exactly the same.
|
||||
[editorconfig][editorconfig] is the standard tool for editing consistency between editors.
|
||||
|
||||
## Dependencies
|
||||
## Use Cases
|
||||
|
||||
None.
|
||||
editorconfig can be used to:
|
||||
|
||||
## Installation
|
||||
- Finally forget about whether spaces or tabs are being used; editorconfig will handle this automatically for you
|
||||
- Share the same indentation settings in all the editors you and your colleagues use
|
||||
|
||||
```sh
|
||||
make package=ediiorconfig
|
||||
```
|
||||
You should not use editorconfig if:
|
||||
|
||||
- You should use editorconfig.
|
||||
|
||||
## Usage
|
||||
|
||||
If you use my [`.vimrc`](/vim) or [code](/code) config, editorconfig will aleady be applied. Otherwise you should read the [editorconfig][editorconfig] website for how to enable it in your editor.
|
||||
If you use my [`.vimrc`](/vim) or [code](/code) config, editorconfig is already applied.
|
||||
|
||||
[editorconfig]: https://editorconfig.org/
|
||||
[editorconfig]: https://github.com/editorconfig/editorconfig
|
||||
|
@ -1,23 +1,26 @@
|
||||
# GPG
|
||||
|
||||
GPG is used to sign and encrypt things.
|
||||
GPG is the standard encryption tool.
|
||||
|
||||
## Dependencies
|
||||
## Use Cases
|
||||
|
||||
- [gnupg][gnupg] - The GNU Privacy Guard
|
||||
gpg can be used to:
|
||||
|
||||
## Installation
|
||||
- Sign things with your signing subkey
|
||||
- Read encrypted messages sent to you with your encryption subkey
|
||||
- Send encrypted messages to other people with their public key
|
||||
- Verify the authenticity of someone's messages and other data with their public key
|
||||
|
||||
```sh
|
||||
make package=gpg
|
||||
```
|
||||
You should not use gpg if:
|
||||
|
||||
- You should use gpg.
|
||||
|
||||
## Usage
|
||||
|
||||
Use gpg as you normally would. Make sure that you export `GPG_TTY` in your shell's init script. This is how you would do it in [fish](/fish):
|
||||
Export `GPG_TTY` in your shell's init script. This is how you would do it in [fish](/fish):
|
||||
|
||||
```fish
|
||||
export GPG_TTY=(tty)
|
||||
```
|
||||
|
||||
[gnupg]: https://www.archlinux.org/packages/core/x86_64/gnupg/
|
||||
[gnupg]: https://github.com/gpg/gnupg
|
||||
|
Loading…
Reference in New Issue
Block a user