Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 3.53 KB

README.md

File metadata and controls

86 lines (55 loc) · 3.53 KB
Raw

Resumos LEIC

Este repo foi criado com o objetivo de partilhar resumos das várias UCs do curso de LEIC-A no Instituto Superior Técnico. Qualquer contribuição é bem-vinda (exceto material de professores, como slides e livros, falem primeiro connosco).

Como contribuir?

Se estás a pensar contribuir para os Resumos LEIC, fizemos um guia passo a passo só para ti! Vai à nossa documentação para aprenderes tudo o que precisas.

Se já percebes do assunto e apenas queres instruções rápidas, segue os passos abaixo.

Instalar ferramentas

Para correr o código localmente, é necessário as seguintes ferramentas: git, nodejs e yarn. Abaixo encontram-se instruções para instalação em Windows e Linux.

Windows

  1. Fazer download do git e instalar o executável.
  2. Fazer download do node e instalar a última versão LTS (18.X ou superior).
  3. Instalar o yarn através da PowerShell, correndo o comando npm i -g yarn.

Linux/macOS

  1. Instalar o git e o node pelo package manager da distribuição. Atenção que o node em Debian/Ubuntu/etc está desatualizado. Recomendo seguir este tutorial para ter o Node 18 LTS.
  2. Instalar o yarn através do terminal, correndo o comando npm i -g yarn.

Obter os ficheiros necessários

  1. Fazer fork do repositório.

  2. Fazer clone do repo:

    git clone git@github.com:<o-teu-username>/resumos-leic.git

  3. Adicionar o remote upstream ao repositório:

    git remote add upstream https://github.com/leic-pt/resumos-leic.git

  4. Instalar dependências:

    cd resumos-leic
yarn               # or yarn install

Alterar conteúdos

Os ficheiros .md (markdown) estão na pasta da respetiva UC dentro de content. Assim que um ficheiro .md é adicionado à respetiva pasta da UC (e esteja associado a um type), é acessível a partir da sidebar. Tem ainda de ser definido o respetivo path (/asa/introducao, por exemplo).
Os ficheiros podem ainda ter diferentes categorias, aparecendo em diferentes sub-secções da sidebar consoante a mesma. Em princípio, ser-vos-á útil apenas a categoria content, que deve ser adicionada ao header de cada ficheiro.

Cada ficheiro deve conter um header com a meta-informação útil correspondente a cada ficheiro, principalmente:

  • title: <título>, onde <título> será o título que aparece associado à página correspondente ao ficheiro nos resumos;

  • description: <bullet points>, secção que deverá indicar sucintamente os pontos importantes abordados neste capítulo dos resumos (e que aparece no embed do URL ao partilhar o link da página);

  • path: /<UC>/<nome-da-pagina>, self-explanatory;

  • type: <categoria>, tal como mencionado acima provavelmente apenas vos interessará a categoria content.

Para iniciar o servidor local, correr o comando:

yarn dev

Formatar o código

Antes de fazer um commit, é recomendado executar o prettier (se usarem um editor de texto - e.g. VSCode - que já executa automaticamente, não é preciso). Devem correr o comando na raiz do repo (/home/.../resumos-leic, portanto).

yarn format

Parceiros

Powered by Vercel