Adicionando Capa ao REAME.md

[ISS2718]

Criei uma imagem onde tentei representar o goICMCsim para usarmos de capa.
Também mudei algumas cosias no README.md, principalmente a parte e contribuição.
Adicionei as contribuições de exemplo dadas no REAME.md atual nas issues com as devidas tags, mas ainda precisa ver se estão todas certas e se há alguma que é uma good first issue.

[ISS2718]

Ah também tem que ver se eu n abri uma issue que já foi fechada.
Estou em dúvida na issue #11

[lucasgpulcinelli]

Gostei bastante das mudanças! A única coisa que queria especificar era essa parte da documentação de como adicionar uma nova instrução.

Fora isso oh god tem um commit chamado "emojis" hahahahaah

[lucasgpulcinelli]

Pera, você poderia me explicar isso? Eu entendi que esse é o link para a imagem, mas como isso foi gerado, e onde esse asset foi definido? Tem documentação sobre para eu dar uma olhada? Gostei bastante

[ISS2718]

Acho q é uma "bugfeature" do GitHub KKKKKK
Aqui nas issues vc consegue fazer upload de imagem e pra isso ele faz upload dessa imagem. Só que como usa markdown aqui tbm ele coloca o link da imagem que foi feito upload e aí eu copiei e usei esse link.

[ISS2718]

[ISS2718]

Outra versão da capa.
Mas devem existir outras formas de fazer isso tbm. Porque no repositório tem como definir uma imagem de Social Preview. Inclusive essas imagens já estão na resolução correta pra ser usadas tbm se vc quiser.

[lucasgpulcinelli]

Essa documentação está em algum lugar? Eu gosto da ideia de deixar bem explicadinho esses passos para criar uma nova instrução porque é algo que será necessário conforme o processador se tornar mais complexo com o passar do tempo.

[ISS2718]

Ainda não tem a Documentação eu não sei onde colocar o arquivo pra ser sincero. Mas dá pra fazer uma mais simples com o exemplo que você usou no README atual.

[ISS2718]

How to add/modify instructions in the simulator

1. Choose an opcode for your instruction.
2. Add it to the constants list at processor/Instruction.go.
3. Right below, in the same file, add your instruction data to the AllInstructions list so it can be found and executed by the simulator.
4. You will need to add four pieces of information:
   • The opcode you just created.
   • An instruction to generate its mnemonic string (if your instruction receives a list of registers, just use genRegM as most instructions, or create a function yourself and add it there).
   • The instruction size in 16-bit words.
   • And a function to execute it.
5. To make the execution function, you will need a function that takes the processor context and returns an error (usually nil, to indicate everything went right).

An instruction example

Let's create a new instruction, called incmod, that takes a register and adds 1 to it, but if it becomes greater than or equal to another register, it wraps around in the same way a mod would. Basically, incmod rx, ry is equal to rx = (rx+1) % ry.
This instruction is going to have opcode 0b111111, plus three bits for the first register, and three more for the second, resulting in 0b111111xxxyyydddd (where x is the first bits for the first register, y is for the second, and d is a don't care value, meaning an unused 0 or 1).

The entry in AllInstructions will be {OpINCMOD, genRegM("incmod", 2), 1, execINCMOD},, where OpINCMOD is defined above in the constant block as OpINCMOD = 0b111111. genRegM is used with those arguments to define the mnemonic and to say that it has two register opcodes in the usual position. 1 is to say that a single word is necessary to encode the instruction. execINCMOD is defined as follows:

func execINCMOD(pr *ICMCProcessor) error {
    // get the instruction binary data
    inst := pr.Data[pr.PC]

    // remember, those are indices from 0-7, not the actual values
    rx_index := getRegAt(inst, 7) // 7 is the first bit from right to left encoding the register index for rx
    ry_index := getRegAt(inst, 4) // same for ry

    // set the value in rx to the result of our operation
    pr.GPRRegs[rx_index] = (pr.GPRRegs[rx_index] + 1) % pr.GPRRegs[ry_index]

    // no errors happend
    return nil
}

[ISS2718]

A gente cria um arquivo pra servir de documentação e coloca essa parte de adicionar uma instrução lá. E vai melhorando essa documentação com o tempo.

[ISS2718]

O que eu vi em repositórios grandes é q eles tem um repositório só pra documentação. Acho q é pra quando alguém clonar não clonar a documentação junto.

[ISS2718]

Comecei a documentação.
Coloquei uma área de contribuidores da documentação, mas é só uma sugestão. Se você achar que não precisa porquê o do README.md já é suficiente pode tirar.

[ISS2718]

Eu fiz um sumário usando os links diretos apara cada tópico ou subtópico, mas não sei se funcionou muito bem.
Se você achar que não está funcionando bem dá pra colocar a URL da página no GitHub para cada subtópico assim eu tenho certeza que funciona!

[lucasgpulcinelli]

Adorei a documentação! Eu vou tentar adicionar mais recursos em PRs futuras, mas por agora nós já temos a base para uma boa documentação graças a você.