~porcellis/t

2aff3bc86489729b95fe098c5fdc450c48cbd535 — Pedro Lucas Porcellis a month ago 9ccc877 master
Add translated version of the README and minor upgrades on the docs
2 files changed, 150 insertions(+), 16 deletions(-)

M README.md
A README.pt-br.md
M README.md => README.md +35 -16
@@ 2,13 2,17 @@

`t` is an minimalistic tool to take notes.

> A version of this README is [available in portuguese][readme-pt-br].

[readme-pt-br]: https://git.sr.ht/~porcellis/t/tree/master/README.pt-br.md

## Philosophy

Instead of using a web editor or some native app that under the hood is
a web page, or even a fully bloated app to take your notes and store it
on someone elses server with their proprietary software and APIs we
rather choose to use something way more simple, a combination of two
very well documented, free and trusted tools: *git* and *markdown*.
Instead of using a web editor or some web browser disguised as a native
app, or even a giant and sluggish app to simple write text notes and
store it on someone else "cloud" with their proprietary software and
APIs we rather choose to use something way more simple, a combination of
two very well documented, free and trusted tools: *git* and *markdown*.

## Design



@@ 16,8 20,8 @@ very well documented, free and trusted tools: *git* and *markdown*.
when taking notes, sometimes all you want is somewhere to drop a bunch
of thoughts.

When writing a note, `t` will open your `EDITOR` (we recommend vim). As
soon that you write all you need and quit the app, `t` will push your
When writing a note, `t` will open your `EDITOR` (or fallback to vim).
As soon that you write all you need and quit the app, `t` will push your
note to the configured git server. That's it.

## Usage


@@ 28,12 32,21 @@ note to the configured git server. That's it.
while piping to the default `PAGER` on your system (usually `less (1)`).

- `create` or `c` will create a new note using the current date. You can supply
a title in quoted strings
a title if you want

- `edit` or `e` will reopen the note on your `EDITOR`, by default it
will edit the last one. You can supply the index of the note you want to edit.

- `show` or `s` will pipe the note to [glow](https://github.com/charmbracelet/glow)
- `show` or `s` will pipe the note to [glow][glow]

- `share` or `sh` will throw the note on the configured shared service,
it defaults to a public instance of [rascunho][rascunho] hosted at
[eletrotupi.com][eletrotupi], but you can customize to your paste
service.

[rascunho]: https://sr.ht/~porcellis/rascunho
[glow]: https://github.com/charmbracelet/glow
[eletrotupi]: https://eletrotupi.com 

You can check the man page `man t` if you need any help.



@@ 50,34 63,40 @@ If you have any interest in packaging this software to your distro of
choice, please let me know, so I can update the steps here.

**Note**: By now, the `show` commands depends on 
[glow](https://github.com/charmbracelet/glow) to be installed.
[glow][glow] to be installed.

## Contributing

The plain, good and old git-way of contributing.

The only dependency is `go`, which you can install trough your package
There's a couple of dependencies, namely `git`, `go`, `less`, and
[glow][glow]. All probably are available to install trough your package
manager (apk on Alpine, pacman on Arch, apt on Debian-based distros
etc). After that, you can use `make get` to fetch all dependencies and
start hacking!

Send your patches to my public-inbox at
[~porcellis/public-inbox@lists.sr.ht](mailto:~porcellis/public-inbox@lists.sr.ht)
[Send your patches][git-send-email] to my public-inbox at
[~porcellis/public-inbox@lists.sr.ht][public-inbox]

(Remember to use [plain text][plain-text])!

(Remember to use [plain text](https://useplaintext.email))!
[public-inbox]: mailto:~porcellis/public-inbox@lists.sr.ht
[plain-text]: https://useplaintext.email
[git-send-email]: https://git-send-email.io

## Roadmap

There's a lot of things I want to implement on `t`, here is some of them:

- Add a improved visualization when displaying notes
- Add a improved visualization when displaying notes, probably using
ncurses
- ~~Support OS Pager when listing notes (this can be achieved by `t list
| less -r`)~~
- Delete a note
- Make setup through `t` (`t init` would create the notes repository, set a remote, etc).
- Add PGP support for notes (this is a must)
- Allow editing by title of note
- Companion UI app [tw](https://git.sr.ht/~porcellis/tw)
- A Companion UI app [tw](https://git.sr.ht/~porcellis/tw)

## License


A README.pt-br.md => README.pt-br.md +115 -0
@@ 0,0 1,115 @@
# t

`t` é uma ferramenta minimalistica de anotação

## Filosofia

Ao invés de usar um editor web ou algum navegador inteiro disfarçado de
uma aplicação nativa, ou até mesmo um aplicativo lento e pesado para
simplesmente escrever texto e armazenar isso na "nuvem" de alguém usando
os programas e APIs proprietárias, optamos  por um caminho bem mais
simples, estar sobre os ombros de duas ferramentas altamente confiáveis,
bem documentadas e livres/abertas: *git* e o formato de texto *markdown*.

## Arquitetura

`t` é feito para ser completamente simples e fora do teu caminho.
Especialmente quando escrevendo anotações, tudo o que você precisa é um
lugar para jogar um monte de pensamentos ali e deu.

Quando você está escrevendo uma anotação, `t` vai abrir o editor de
texto configurado na variável de ambiente `EDITOR` (ou se não estiver
declarado, abrirá o vim). Assim que você terminar de escrever e fechar
o aplicativo, `t` vai jogar as suas anotações para o servidor git
configurado. É isto.

## Uso

`t` tem uma pequena lista de comandos:

- `list` ou `l` vai listar todas as anotações indexado pela data de
modificação, enquanto passa essa lista adiante para o que estiver
configurado na variável de ambiente `PAGER` no seu sistema (geralmente
`less (1)`).

- `create` ou `c` vai criar uma nova anotação usando a data atual. Caso
você queira você pode passar um título para a anotação.

- `edit` ou `e` vai reabrir a anotação no seu `EDITOR`, e por padrão vai
abrir a ultima anotação feita. Você pode passar um indice para esse
comando.

- `show` ou `s` vai jogar a anotação para dentro do [glow][glow]
e mostrar na sua tela. Esse comando também recebe um índice.

- `share` ou `sh` vai passar a anotação para o serviço de
compartilhamento configurado, por padrão ele manda para uma instancia
pública do [rascunho][rascunho] hospedado em
[eletrotupi.com][eletrotupi], mas você pode customizar para utilizar
o seu serviço favorito.

[rascunho]: https://sr.ht/~porcellis/rascunho
[glow]: https://github.com/charmbracelet/glow
[eletrotupi]: https://eletrotupi.com

Consulte o manual local e offline `man t` se você precisar de alguma
ajuda.

## Instalando

Por enquanto, a única forma de instalar é clonar esse repositório
e rodar os comandos de instalação.

Então, abra seu terminal e digite esses comandos:
- `git clone https://git.sr.ht/~porcellis/t`
- `make && sudo make install`

Se você tem algum interesse em empacotar esse projeto para sua
distribuição, por favor me avise para que eu possa atualizar as
instruções aqui.

**Aviso**: Por enquanto, o comando `show` depende de já ter sido
efetuada a instalação do [glow][glow].

## Contribuindo

A forma padrão, boa e velha do git.

Existe algumas dependências, em especial o `git`, `go`, `less` e o já
mencionado [glow][glow]. Todas essas ferramentas, provavelmente, estão
disponíveis de serem instaladas usando o seu gerenciador de pacotes da
sua distribuição (apk no Alpine, pacman no Arch Linux, apt em
distribuições baseadas no Debian, etc). Depois disso, você pode usar
o comando `make get` dentro da pasta do repositório para baixar todas as
dependências e bibliotecas usadas pelo `go get` e começar a modificar.

[Envie seus patches e modificações][git-send-email] para minha caixa de
entrada pública: [~porcellis/public-inbox@lists.sr.ht][public-inbox]

(Lembre-se de usar [apenas texto][plain-text])!

[public-inbox]: mailto:~porcellis/public-inbox@lists.sr.ht
[plain-text]: https://apenastexto.eletrotupi.com
[git-send-email]: https://git-send-email.io

## Futuro

Tem várias coisas que eu gostaria de implementar, algumas delas são:

- Adicionar uma forma melhorada de visualização quando listar
anotações, provavelmente usando ncurses
- ~~Oferecer suporte ao Pager do sistema operacional quando listar
anotações, hoje pode ser resolvido paliativamente com o comando `t list
| less -r`~~
- Deletar uma anotação
- Adicionar um comando para configurar o projeto passo-a-passo, criar
repositório, adicionar um servidor, etc.
- Adicionar suporte a encriptação das anotações (isso é prioridade)
- Permitir editar uma anotação pelo seu título
- Aplicativo nativo desktop [tw](https://git.sr.ht/~porcellis/tw)

## Licença

Sob os termos da licença GNU GPL-3.0, verifique o arquivo
[LICENSE](https://git.sr.ht/~porcellis/t/tree/master/LICENSE) para mais
informações.