Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rafael-santiago committed Aug 22, 2023
1 parent 39f1b4e commit 9600add
Show file tree
Hide file tree
Showing 6 changed files with 82 additions and 2 deletions.
67 changes: 66 additions & 1 deletion doc/CodeOrganization.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ besides some project and design decisions.
- [How to avoid breaking coverage build?](#how-to-avoid-breaking-coverage-build)
- [Coverage measures updating](#coverage-measures-updating)
- [Design decision about libc and OS includes](#design-decision-about-libc-and-os-includes)

- [How does versioning work on `macgonuts`?](#how-does-versioning-work-on-macgonuts)
- [But why taking this so unpopular decision?](#but-why-taking-this-so-unpopular-decision)
## The repo layout

This is the current repo layout:
Expand Down Expand Up @@ -145,3 +146,67 @@ code space with so repetitive include statements. Thus, we can include what we n
focusing on implementing that exact part and, period.

[``Back``](#topics)

## How does versioning work on `macgonuts`?

<p align="center">
<img src="https://github.com/rafael-santiago/macgonuts/blob/update-doc/etc/warning_unpopular_content.png" title="I love The Cramps, don't you?"
alt="I love The Cramps, don't you?" width="320" /><br>
<img src="https://github.com/rafael-santiago/macgonuts/blob/update-doc/etc/the_surprise_in_terror_1790.png" title="The Surprise in Terror (1790) by Joseph Ducreux (Public Domain)"
alt="The Surprise in Terror (1790) by Joseph Ducreux (Public Domain)" width="320" />
<img src="https://github.com/rafael-santiago/macgonuts/blob/update-doc/etc/le_discret_1791.png" title="Le Discret (1791) by Joseph Ducreux (Public Domain)"
alt="The Surprise in Terror (1790) by Joseph Ducreux (Public Domain)" width="320" />
</p>

After thinking about endless months! I have decided to use an arcane and unusual (really) way of versioning computer
programs. It is so unusual that deserves a whole paragraph and in all caps (sorry).

HERE WE ARE USING INTEGERS AND ALWAYS COUNTING IN ASCENDENT ORDER, STARTING FROM THE NUMBER ONE.

Very, very unusual. So unusual that it need to be more well explained. One more paragraph (no caps, I promise)...

So, the first version is `v1`, the next `v2` and after `v3`. Now is up to you...

I tried avoid reinventing math axioms, better to stick with the previous, they work and they are amazing.

Now, in other words: arabic numbers going in ascendent order starting from one, prefixed with `v` (suggesting "version").

With this decision, unfortunately, here you will not find ridiculous names (besides `macgonuts`)... You know,
things like:

- `vCucumber-from-space-and-beyond`
- `vProjeto-pangaio`
- `vMais-um`
- `v_i`
- `v_ii`
- `v_ii.i`
- `vVamos-ver-se-agora-vai-1.2.3.4.5.6`
- `v3.14+E10`
- `vNome-de-pessoa-aleatório-e-bem-bobo`
- `vZumbi-pindoba`
- `vMais-um-jabuti-que-subiu-na-arvore`
- `vNomeDeAnimalFofuxim`
- `vHlp_whr_r_th_vgls`

etc...

Instead, here we will find:

- `v1`

and possibly:

- `v2`
- `v3`
- `v4`

- and counting... if we have new ideas or bugs to fix... Because here subjectless "new" versions are totally pointless.

[``Back``](#topics)

### But why taking this so unpopular decision?

`Macgonuts` is the only ridiculous name that you will find here, there is no place for another one.
It is a thing like `Highlanders`. We are predatory about it, period.

[``Back``](#topics)
17 changes: 16 additions & 1 deletion doc/MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,20 @@ This section describes in details all implemented commands in ``macgonuts``. Kee
the tool and making a youtube video about it (because I do not have any talent or even patience to do this),
many thanks in advance! :satisfied:

Maybe you should also try out slides to speak in some tech talk as a kind of excuse to promote
sleepiness orgies around the World. Seriously, I also do not have any patience to this kind of stuff... What about?!
People sometimes are lot strange, getting together to sleep in uncomfortable positions, craziness...
In **Figure 1** you can see a typical conference listener :satisfied:

<p align="center">
<img src="https://github.com/rafael-santiago/macgonuts/blob/update-doc/etc/sloth_yawm.gif" title="Zzzz..."
alt="'- Questions? - Questions? - Gimme a question, pleeease?!'" width="320" /><br>
<b>Figure 1</b>: In this figure you see a "hacker" self-claimed "Casanova" at<br>
<i>the most interesting part of a sleepines... oh! tech talk</i>.
</p>

But let's focus on the `macgonuts`...

### The spoof command

><img src="https://github.com/rafael-santiago/macgonuts/blob/update-doc/etc/angry-hiss.gif" title="Grrrr! C4uTion is now logged in..."
Expand Down Expand Up @@ -661,7 +675,8 @@ Anyway, if jot down `xablau` is too much for you, you can try its well behaved a
drive away this noisy host from your gateway (wait... `_ modprobe -rf euphemism`) err... You can cut off its
`Internet` access and with it rip off all this bandwidth slice all to you :trollface:, :godmode:!

In order to achive this misconduct with `macgonuts` all you need is:
In order to achive this misconduct with `macgonuts` all you need is... "- love?"... Love is always good
but not in this case, here you need to:

<p align="center">
<img src="https://github.com/rafael-santiago/macgonuts/blob/main/etc/keep_calm_and_caleaboqui.jpg" title="shhh..."
Expand Down
Binary file added etc/le_discret_1791.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added etc/sloth_yawm.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added etc/the_surprise_in_terror_1790.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added etc/warning_unpopular_content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9600add

Please sign in to comment.