quarta-feira, 29 de junho de 2016

O que escrever no README.md do seu projeto no Github


Antes de sitar os tópicos, é boa pratica criar a descrição do seu projeto no README.md em inglês, pois as chances de pessoas de outros países verem seu projeto é grande, e não queremos que eles não entendam o que o nosso projeto faz, não é mesmo? Então sempre que possível escreva a descrição em inglês. 

Sinopse/Synopsis
Na parte superior do arquivo deve haver uma breve introdução e / ou visão geral que explica o que é o projeto. Esta descrição deve corresponder descrições adicionados para os gestores de pacotes (gemspec, package.json, etc.)


Exemplo de código/Code Example
Os desenvolvedores devem ser capazes de descobrir como seu projeto resolve o seu problema, olhando para o exemplo de código. Verifique se a API que você está mostrando é óbvio, e que o código é curto e conciso.

Motivação/Motivation
Uma breve descrição da motivação por trás da criação e manutenção do projeto. Isso deve explicar por que existe o projeto.

Instalação/Installation
Fornecer exemplos de código e explicações sobre como obter o projeto.

Referência API/API Reference
Dependendo do tamanho do projeto, se for pequena e simples o suficiente para os documentos de referência pode ser adicionado ao README. Para o tamanho médio a grandes projectos é importante, pelo menos, fornecer um link para onde os documentos de referência API viver.

Testes/Tests
Descrever e mostrar como executar os testes com exemplos de código.

Contribuintes/Contributors
Que as pessoas saibam como eles podem mergulhar no projeto, incluem links importantes para coisas como rastreadores de problemas, irc, contas de Twitter, se aplicáveis.

Licença/License
Um trecho curto descrevendo a licença (MIT, Apache, etc.)

terça-feira, 28 de junho de 2016

Escrevendo em Markdown

Agora vamos praticar, e escrever em Markdown, para visualizar os exemplos é só abrir: Exemplos do Tutorial e ir acompanhando como fica cada coisa. 


Títulos


Para marcar um título, você vai usar # a quantidade de vezes que irá representar o nível do título. Exemplo:


1
2
3
4
5
6
# Título nível 1
## Título nível 2
### Título nível 3
#### Título nível 4
##### Título nível 5
###### Título nível 6


Parágrafos e quebras de linha

Para gerar parágrafos, basta você escrever o texto em uma linha:


1
2
3
4
5
Título de nível 1
==================
  
Título de nível 2
------------------


 view


Parágrafos e quebras de linha
Para gerar parágrafos, basta você escrever o texto em uma linha:


1
2
3
Este é um parágrafo.
  
Este é outro parágrafo.

Mas a documentação do Markdown diz que, para quebras de linha, você precisa deixar dois espaços no final da linha:

1
2
Primeira linha do parágrafo. [espaço][espaço]
Segunda linha do parágrafo.

Coloquei o [espaço] no final da primeira linha somente para facilitar a visualização. Você deve substituir por dois espaços em branco.


Links 
Para gerar links, você usa [](). Dentro dos colchetes você coloca o texto do link, e dentro dos parênteses, você coloca a URL:

1
[Blog da Mel](http://melissalobo.blogspot.com.br)

Links automáticos

Se o texto do seu link é o próprio link, você pode envolvê-lo entre < link >, que o link será gerado automaticamente:

1
<https://www.google.com.br>

Listas

Para listas não ordenadas, você pode usar *, + ou -. Veja:

1
2
3
4
5
6
7
8
9
10
11
* Item 1
* Item 2
* Item 3
  
+ Item 1
+ Item 2
+ Item 3
  
- Item 1
- Item 2
- Item 3

E para listas ordenadas, você usa o número, seguido de ponto:

1
2
3
1. Item 1
2. Item 2
3. Item 3

Imagens

Geração de imagens é bem parecido com a geração de links: você só precisa adicionar uma ! no início. E o texto que você coloca entre os colchetes, é usado como alt na imagem:

1
![Eu](https://fbcdn-sphotos-e-a.akamaihd.net/hphotos-ak-xlt1/v/t1.0-9/13124556_984154084999068_6786632002907995125_n.jpg?oh=61d6c4b591caf5ed56d3a71d57d19fc3&oe=5807A2F9&__gda__=1476901864_0192b37cb7089c22bd73bd5c303dcdcc)

Backslash scapes

Para escapar caracteres que são parseados pelo Markdown, você pode usar a barra invertida \, seguida do caractere, para imprimi-lo literalmente. O escape funciona para os caracteres listados abaixo:

1
2
3
4
5
6
7
8
9
10
11
12
\   backslash (barra invertida)
`   backtick (crase)
*   asterisk (asterisco)
_   underscore
{}  curly braces (chaves)
[]  square brackets (colchetes)
()  parentheses (parênteses)
#   hash mark (sustenido / hash / jogo da velha)
+   plus sign (sinal de "mais" ou somar)
-   minus sign (hyphen) (sinal de menos ou hífen)
.   dot (ponto)
!   exclamation mark (ponto de exclamação)


Para saber mais sobre Markdown, recomendo a leitura da documentação oficial:
http://daringfireball.net/projects/markdown/
E alguns links de como o Github usa Markdown, que foi onde eu descobri tudo isso que postei:
https://help.github.com/articles/markdown-basics | https://help.github.com/articles/github-flavored-markdown/

segunda-feira, 27 de junho de 2016

O que é Markdown?

Markdown é uma ferramenta de conversão de text-to-HTML. Com ele é possível você marcar títulos, listas, tabelas, etc., de forma muito mais limpa, legível e precisa, do que se fosse fazer com HTML.

Eu particularmente uso ela somente no Github por enquanto, no README.md, que é um arquivo que fica na raiz do seu projeto, e é renderizado pelo Github abaixo da lista de arquivos. Aquele texto que você lê quando acessa um repositório é um arquivo README.md, escrito em Markdown.
Mas ela pode ser utilizada na maior parte dos geradores de estáticos (Hexo, Jekyll, HarpJS, Docpad, etc.).

Escrever em Markdown

Para começar a escrever em Markdown, você só precisa criar um arquivo com uma dessas extensões: mark, markdown, md, mdml, mdown, text, mdtext, mdtxt, mdwn, mkd, mkdn. Entre essas, a mais utilizada é a md. Crie um arquivo com uma dessas extensões e você já estará apto para começar a escrever em Markdown! 
E usar um Markdown Editor, existe vários, como o Stack Edit que converte Markdown para HTML enquanto você digita.

domingo, 26 de junho de 2016

Meetup Java São Paulo 11

Pessoal vem ai o décimo primeiro Meetup Java São Paulo

Quando: Sexta-feira, 1 de Julho de 2016, as 19:30.

Agenda

19:40h
Bruno Daniel Marinho (Photon Group)
Introdução sobre  Big Data. 
20:20h
Felipe Adorno (Netshoes)
Microservices com Netflix oss.
Depois bate papo!  


Onde: Auditório da GlobalCode
Av. Bernardino de Campos, 327, São Paulo, 04004-050 , São Paulo, São Paulo
obs: Bem próximo ao metro Paraíso, saindo do metro segue sentido consolação. 

Link do Evento: Meetup Java São Paulo 11

quarta-feira, 1 de junho de 2016

Conceitos básicos - Colinha


  • IP: cada usuário e cada site tem um endereço, o chamado IP, um conjunto de números que serve como identidade de quem usa. É a partir desse caminho que os protocolos saberão de onde veio o pedido, para quem veio e para onde ele deve enviar a informação.
  • Pacotes TCP/IP: basicamente, toda informação transmitida entre IPs vem em pacotes, os quais têm formatos preestabelecidos. Como todas as requisições obedecem à mesma linguagem, essas informações precisam vir organizadas e ordenadas para que sejam compreendidas. Esses pacotes estão relacionados aos dados transmitidos pelas redes.
  • Servidor DNS (Domain Name Service): é o lugar onde ficam registrados os nomes e os IPs dos sites. É impossível ter dois endereços iguais, porque cada um vai armazenar informações referentes a um site. Além desses, existem ainda servidores responsáveis só por armazenar o conteúdo dos sites.
  • Sistemas CMS (Content Management System): são sistemas responsáveis por organizar o conteúdo para um site. Por isso que para gerenciar um blog não precisamos saber programar. Existem interfaces que auxiliam os usuários a colocarem suas informações e o que desejam publicar.
  • Cookies: quando visitamos algum site, deixamos esse pequeno registros. Ele indica ao servidor que já visitamos aquele site alguma vez e nos ajuda a personalizar a navegação na Internet.
  • HTTP: é a sigla para para “HyperText Transfer Protocol”, ou “Protocolo de Transferência de Hipertexto”, em português. Esse é o tal sistema de pedidos que a Internet utiliza, e ele nada mais é do que o estabelecimento de algumas “regrinhas” para essa troca de dados. Em outras palavras, é como se fossem as regras para envio de uma correspondência comum, nos correios