search

COPPE-UFRJ / CoppeTeX

A LaTeX toolkit for writing thesis and dissertations at COPPE/UFRJ
GNU General Public License v3.0
59 stars 17 forks source link

Estrutura do repositório #17

Open EduardoMangeli opened 4 years ago

EduardoMangeli commented 4 years ago

Podemos mudar a estrutura do repositório para incluir exemplos, código fonte e arquivos de distribuição da classe. Isso tudo incluindo a organização sugerida em https://github.com/COPPE-UFRJ/CoppeTeX/issues/16

Proponho que tenhamos, ao menos, três diretórios para facilitar essa organização, além da raiz do repositório:

src
contendo os arquivos fonte
dist
contendo os arquivos da distribuição
examples
contendo examples
raiz
contendo o readme.md, .gitignore, etc
vicentehelano commented 4 years ago

Concordo! Ótima ideia!

Em sáb, 29 de fev de 2020 às 18:15, Eduardo Mangeli < notifications@github.com> escreveu:

Podemos mudar a estrutura do repositório para incluir exemplos, código fonte e arquivos de distribuição da classe. Isso tudo incluindo a organização sugerida em #16 https://github.com/COPPE-UFRJ/CoppeTeX/issues/16

Proponho que tenhamos, ao menos, três diretórios para facilitar essa organização, além da raiz do repositório: src contendo os arquivos fonte dist contendo os arquivos da distribuição examples contendo examples raiz contendo o readme.md, .gitignore, etc

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/COPPE-UFRJ/CoppeTeX/issues/17?email_source=notifications&email_token=AAN724XXG6OFTS5ENYIV5ZLRFF5F7A5CNFSM4K66LSFKYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4IRNSUQQ, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAN724VP7S4KBIKRWUY2W7DRFF5F7ANCNFSM4K66LSFA .

xexeo commented 4 years ago

A distribuição não seria uma release?

Xexéo

On Tue, Mar 3, 2020 at 1:57 PM Vicente Helano notifications@github.com wrote:

Concordo! Ótima ideia!

Em sáb, 29 de fev de 2020 às 18:15, Eduardo Mangeli < notifications@github.com> escreveu:

Podemos mudar a estrutura do repositório para incluir exemplos, código fonte e arquivos de distribuição da classe. Isso tudo incluindo a organização sugerida em #16 https://github.com/COPPE-UFRJ/CoppeTeX/issues/16

Proponho que tenhamos, ao menos, três diretórios para facilitar essa organização, além da raiz do repositório: src contendo os arquivos fonte dist contendo os arquivos da distribuição examples contendo examples raiz contendo o readme.md, .gitignore, etc

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub < https://github.com/COPPE-UFRJ/CoppeTeX/issues/17?email_source=notifications&email_token=AAN724XXG6OFTS5ENYIV5ZLRFF5F7A5CNFSM4K66LSFKYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4IRNSUQQ , or unsubscribe < https://github.com/notifications/unsubscribe-auth/AAN724VP7S4KBIKRWUY2W7DRFF5F7ANCNFSM4K66LSFA

.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/COPPE-UFRJ/CoppeTeX/issues/17?email_source=notifications&email_token=AAZ4RDPBOROXS6FEUW3KBLTRFUZGNA5CNFSM4K66LSFKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENUJBJQ#issuecomment-594055334, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAZ4RDIJOOHS2RIUGID7PETRFUZGNANCNFSM4K66LSFA .

-- Geraldo Xexéo, D.Sc. Professor Pleno - Programa de Engenharia de Sistemas e Computação/COPPE-UFRJ Professor Associado - Departamento de Ciência da Computação,/IM-UFRJ Professor do MBA em Engenharia de Software da Escola Politécnica-UFRJ Professor Coordenador de Cadeira no Curso de Tec. de Computação do CEDERJ-CECIERJ Membro da SBC, ACM, IGDA e ABSEL

EduardoMangeli commented 4 years ago

Sim. Mas não acho que essas coisas sejam mutuamente excludentes.

Com um diretório com os arquivos de distribuição, um clone do repositório traria todos os arquivos sem a necessidade de compilar os fontes ou baixar a release correspondente.

A distribuição não seria uma release? Xexéo … On Tue, Mar 3, 2020 at 1:57 PM Vicente Helano @.> wrote: Concordo! Ótima ideia! Em sáb, 29 de fev de 2020 às 18:15, Eduardo Mangeli < @.> escreveu: > Podemos mudar a estrutura do repositório para incluir exemplos, código > fonte e arquivos de distribuição da classe. Isso tudo incluindo a > organização sugerida em #16 > <#16> > > Proponho que tenhamos, ao menos, três diretórios para facilitar essa > organização, além da raiz do repositório: > src contendo os arquivos fonte dist contendo os arquivos da distribuição > examples contendo examples raiz contendo o readme.md, .gitignore, etc > > — > You are receiving this because you are subscribed to this thread. > Reply to this email directly, view it on GitHub > < #17?email_source=notifications&email_token=AAN724XXG6OFTS5ENYIV5ZLRFF5F7A5CNFSM4K66LSFKYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4IRNSUQQ >, > or unsubscribe > < https://github.com/notifications/unsubscribe-auth/AAN724VP7S4KBIKRWUY2W7DRFF5F7ANCNFSM4K66LSFA > > . > — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#17?email_source=notifications&email_token=AAZ4RDPBOROXS6FEUW3KBLTRFUZGNA5CNFSM4K66LSFKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENUJBJQ#issuecomment-594055334>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAZ4RDIJOOHS2RIUGID7PETRFUZGNANCNFSM4K66LSFA . -- Geraldo Xexéo, D.Sc. Professor Pleno - Programa de Engenharia de Sistemas e Computação/COPPE-UFRJ Professor Associado - Departamento de Ciência da Computação,/IM-UFRJ Professor do MBA em Engenharia de Software da Escola Politécnica-UFRJ Professor Coordenador de Cadeira no Curso de Tec. de Computação do CEDERJ-CECIERJ Membro da SBC, ACM, IGDA e ABSEL

vicentehelano commented 4 years ago

Seriam então os arquivos que colocaríamos no CTAN!

Em ter., 3 de mar. de 2020 às 17:08, Eduardo Mangeli < notifications@github.com> escreveu:

Sim. Mas não acho que essas coisas sejam mutuamente excludentes.

Com um diretório com os arquivos de distribuição, um clone do repositório traria todos os arquivos sem a necessidade de compilar os fontes ou baixar a release correspondente.

A distribuição não seria uma release? Xexéo … <#m4255425340588414123> On Tue, Mar 3, 2020 at 1:57 PM Vicente Helano @.> wrote: Concordo! Ótima ideia! Em sáb, 29 de fev de 2020 às 18:15, Eduardo Mangeli < @.> escreveu: > Podemos mudar a estrutura do repositório para incluir exemplos, código > fonte e arquivos de distribuição da classe. Isso tudo incluindo a

organização sugerida em #16 https://github.com/COPPE-UFRJ/CoppeTeX/issues/16 > <#16 https://github.com/COPPE-UFRJ/CoppeTeX/issues/16> > > Proponho que tenhamos, ao menos, três diretórios para facilitar essa > organização, além da raiz do repositório: > src contendo os arquivos fonte dist contendo os arquivos da distribuição > examples contendo examples raiz contendo o readme.md, .gitignore, etc > > — > You are receiving this because you are subscribed to this thread. > Reply to this email directly, view it on GitHub > < #17 https://github.com/COPPE-UFRJ/CoppeTeX/issues/17?email_source=notifications&email_token=AAN724XXG6OFTS5ENYIV5ZLRFF5F7A5CNFSM4K66LSFKYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4IRNSUQQ , > or unsubscribe > < https://github.com/notifications/unsubscribe-auth/AAN724VP7S4KBIKRWUY2W7DRFF5F7ANCNFSM4K66LSFA

. > — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#17 https://github.com/COPPE-UFRJ/CoppeTeX/issues/17?email_source=notifications&email_token=AAZ4RDPBOROXS6FEUW3KBLTRFUZGNA5CNFSM4K66LSFKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENUJBJQ#issuecomment-594055334>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAZ4RDIJOOHS2RIUGID7PETRFUZGNANCNFSM4K66LSFA . -- Geraldo Xexéo, D.Sc. Professor Pleno - Programa de Engenharia de Sistemas e Computação/COPPE-UFRJ Professor Associado - Departamento de Ciência da Computação,/IM-UFRJ Professor do MBA em Engenharia de Software da Escola Politécnica-UFRJ Professor Coordenador de Cadeira no Curso de Tec. de Computação do CEDERJ-CECIERJ Membro da SBC, ACM, IGDA e ABSEL

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/COPPE-UFRJ/CoppeTeX/issues/17?email_source=notifications&email_token=AAN724X5KQSEUVXWML6EFUDRFVPUPA5CNFSM4K66LSFKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENU6V3Q#issuecomment-594143982, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAN724XUQEE43LJEOAMQBOTRFVPUPANCNFSM4K66LSFA .

EduardoMangeli commented 4 years ago

Alterei a estrutura do repositório conforme conversamos. Modifiquei o Makefile para que o resultado das compilações fossem copiados para o diretório dist.

Fiz alguns testes e parece que está ok

vicentehelano commented 4 years ago

Eduardo, no 'dist' não deveríamos colocar os estilos extraídos do arquivo '.dtx' (o coppe.cls, coppe.ist, coppe-unsrt.bst, etc)? Outra coisa, o arquivo de exemplo é extraído do 'dtx', pois ele faz parte do texto da documentação. Por exemplo,

|- COPYING | - README.md | - TODO |- dist |- coppe.pdf |- coppe.cls |- coppe-logo.pdf |- coppe-logo.eps |- coppe-plain.bst |- coppe-unsrt.bst |- coppe.ist |- example.tex |- example.bib |- example.pdf

A gente também havia pensado em criar pacotes com templates.

O que acham?

Em ter., 17 de mar. de 2020 às 16:47, Eduardo Mangeli < notifications@github.com> escreveu:

Alterei a estrutura do repositório conforme conversamos. Modifiquei o Makefile para que o resultado das compilações fossem copiados para o diretório dist.

Fiz alguns testes e parece que está ok

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/COPPE-UFRJ/CoppeTeX/issues/17#issuecomment-600263947, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAN724V76DJUQTBVYCI2VN3RH7HUVANCNFSM4K66LSFA .

EduardoMangeli commented 4 years ago

Eu concordo plenamente. Acabei me deixando levar pelo arquivo Makefile e acho que não fiz o que deveria. Vou modificar a target install para copiar todos os arquivos necessários para o dist.

EduardoMangeli commented 4 years ago

Criei o target build que copia os arquivos da classe para o diretório dist

O arquivo latexmkrc é um arquivo de configuração para o pacote latexmk que é usado pelo Overleaf para configurar a compilação do projeto. O arquivo incluído aqui gera a lista de símbolos e abreviações, algo que não funcionaria no Overleaf sem essa configuração. Não sei qual a melhor forma de distribuí-lo

vicentehelano commented 4 years ago

Está ótimo!

Em ter, 17 de mar de 2020 às 19:34, Eduardo Mangeli < notifications@github.com> escreveu:

Criei o target build que copia os arquivos da classe para o diretório dist

O arquivo latexmkrc é um arquivo de configuração para o pacote latexmk que é usado pelo Overleaf para configurar a compilação do projeto. O arquivo incluído aqui gera a lista de símbolos e abreviações, algo que não funcionaria no Overleaf sem essa configuração. Não sei qual a melhor forma de distribuí-lo

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/COPPE-UFRJ/CoppeTeX/issues/17#issuecomment-600333623, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAN724STMSLUGGMRQVNADM3RH73I5ANCNFSM4K66LSFA .