Skip to content

Commit

Permalink
Organize READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
deniscostadsc committed Feb 27, 2024
1 parent f5d8d14 commit c0690fd
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 13 deletions.
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ status](https://github.com/deniscostadsc/dotfiles/actions/workflows/ci.yml/badge
- [Terminal prompt](#terminal-prompt)
- [Terminal history](#terminal-history)
- [Code Editors](#code-editors)
- [Neovim](#neovim)
- [Visual Studio Code](#visual-studio-code)
- [Docker](#docker)
- [Git](#git)
- [SSH](#ssh)
Expand Down Expand Up @@ -153,16 +151,9 @@ $ history

### Code Editors

#### Neovim
Look at [code editors README](roles/code_editors/README.md)

Creates copy all Neovim configs and created a alias to open Neovim by typing
`vim`. It also install [Ag (The Silver
Searcher)](https://github.com/ggreer/the_silver_searcher) which is used by the
[ack.vim](https://github.com/mileszs/ack.vim) plugin Ack.

#### Visual Studio Code

TODO

### Docker

Expand All @@ -174,12 +165,11 @@ Docker. Like images, containers, cache, volumes, etc..

### Git

TODO
Look at [git role README](roles/git/README.md)

### SSH

Creates to SSH keys, one for work and one for personal purposes. Because of that
I need to set all remotes of work repositories as `work.github.com`.
To enable the coexistance of two SSH keys, one for work and one for personal purposes, I set the work SSH key to impact only the domain `work.github.com`. For that reason, after I clone the repositories from work I need to change the remote URL to add the suffix `work.`.

## Troubleshooting

Expand Down
12 changes: 12 additions & 0 deletions roles/code_editors/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Code editors

## Neovim

Creates copy all Neovim configs and created a alias to open Neovim by typing
`vim`. It also install [Ag (The Silver
Searcher)](https://github.com/ggreer/the_silver_searcher) which is used by the
[ack.vim](https://github.com/mileszs/ack.vim) plugin Ack.

## Visual Studio Code

TODO
3 changes: 3 additions & 0 deletions roles/git/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Git

TODO

0 comments on commit c0690fd

Please sign in to comment.