diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..cae1cea --- /dev/null +++ b/Readme.md @@ -0,0 +1,41 @@ +# Como contribuir para o sítio Web da ANSOL + +## Novo evento para a agenda: + +Os eventos são adicionados à agenda criando um novo ficheiro em em formato markdown [content/eventos/](./content/eventos). Adicionalmente pode ser adicionado um ficheiro com uma imagem para "cover", idealmente no formato svg. + +### Instruções + +1. criar umas directoria em `content/eventos/`, dedicada ao evento (por exemplo "content/eventos/AAAA-MM-DD-megahackaton"). +2. na sub-directoria de evento deverá ser criado um ficheiro chamado index.md, com o conteúdo como este template de exemplo: +``` +--- +layout: evento +title: Nome do evento +metadata: + event: + location: Local Mega fixe, Rua super-cool, nº 1 2A, 9999-999 Cidade + site: + url: https://website.do.evento.org/ + date: + start: AAAA-MM-DD + finish: AAAA-MM-DD +--- +``` +3. caso haja uma imagem de cover, ela deve ser colocada na directoria do evento e ter o nome `cover` (por exemplo: cover.svg, ou cover.png). + +Exemplo de layout de ficheiros para um evento na agenda: +``` +content/eventos/ + . + .. + AAAA-MM-DD-megahackaton/ + . + .. + index.md + cover.svg +``` + +# Licença + +Como podem ver no ficheiro [LICENSE](./LICENSE), o sítio Web da ANSOL está licenciado de com a licença GNU Affero General Public License Version 3 (AGPLv3).