Skip to content

Commit

Permalink
docs(README) update with small stylistic details
Browse files Browse the repository at this point in the history
  • Loading branch information
tsandrini authored Jan 4, 2024
1 parent aa77ef8 commit 38568e0
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,38 +13,38 @@
6. [Impurities](6-impurities)
7. [References](7-references)

## 1. About
## 1. About ❄️

**tensorfiles** represent a set of _fully covariant_, that is invariant to the
chosen coordinate system (**they work on every machine**), fundamental
laws of computing (**how to build my fancy flashy terminals**)
laws of computing (**how to build my fancy flashy terminals**) ☁️

![img](parts/pkgs/docs/docs/assets/images/showcase_1.png)
![img](parts/pkgs/docs/docs/assets/images/showcase_2.png)

For more info refer to the [documentation](https://tsandrini.github.io/tensorfiles/).
The project is also hosted at on [FlakeHub](https://flakehub.com/flake/tsandrini/tensorfiles/).
The project is also hosted on [FlakeHub](https://flakehub.com/flake/tsandrini/tensorfiles/).

## 2. Design choices
## 2. Design choices ⚙️

- This project follow the following template
[https://github.com/tsandrini/practical-flakes-template](https://github.com/tsandrini/practical-flakes-template)
which makes it super easy to share modularity between different projects.
- Modules are disabled by default. Why you might ask? 🤓 Setting
- Modules are disabled by default. Why you might ask? 🤓 ... Setting
`myModule.enable = true;` can be done from multiple places, moreover we can
even assign priorities to these expressions (by utilising `lib.mkOverride`),
however, we can import a given module once and only once ... additional imports
will yield errors. This behaviour makes it hard to reason about the dependencies
of individual modules, which is why I opted for the behaviour --
import everything and enable only the parts that you need.
- Isolate home manager functionality in such a way so it can be used in non
NixOS environments
NixOS environments 👥

## 3. Software
## 3. Software 🖥️

TODO

### 3.1. Academics
### 3.1. Academia 👩🏽‍💼

TODO comment more?

Expand All @@ -63,7 +63,7 @@ TODO comment more?
keep my long-term memory of different subjects fresh using flashcards. I sync
the cards using ankis official cloud.

### 3.2. Secrets
### 3.2. Secrets 🔑

For my day to day passwords I use a locally synced
[keepassxc](https://keepassxc.org/) encrypted database and for the NixOS based
Expand All @@ -74,11 +74,11 @@ ones instead (for obvious reasons).
_Note_: plz no pwn xd, if you see any vulnerabilities please DM me instead,
thanks <3.

## 4. Installation
## 4. Installation 💾

TODO

## 5. Troubleshooting
## 5. Troubleshooting 😵‍💫

### `Write error: disk full;` during `nixos-install`

Expand Down Expand Up @@ -110,13 +110,13 @@ tmpfs, for example
mount -o remount,size=15G /tmp
```

## 6. Impurities
## 6. Impurities 💩

- some of the packages in [NUR](https://github.com/nix-community/NUR) require
running `--impure`
- devenv requires `--impure` flag for commands

## 7. References
## 7. References 📚

The whole nix ecosystem is in its foundations a revolutionary piece of
software and once you get the hang of it you feel like you&rsquo;ve really
Expand Down

0 comments on commit 38568e0

Please sign in to comment.