From 8b12288df6dc1946fa4b731c751cb3c87ea5e146 Mon Sep 17 00:00:00 2001
From: Matei Adriel <rafaeladriel11@gmail.com>
Date: Wed, 11 Jan 2023 10:19:49 +0100
Subject: [PATCH] Added a basic readme
---
.gitignore | 2 +-
README.md | 30 +++++++++++++++++++++
dotfiles/neovim/lua/my/plugins/moonwalk.lua | 20 --------------
flake.nix | 6 ++---
4 files changed, 34 insertions(+), 24 deletions(-)
create mode 100644 README.md
delete mode 100644 dotfiles/neovim/lua/my/plugins/moonwalk.lua
diff --git a/.gitignore b/.gitignore
index 68dee6b..8fe2320 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,4 +2,4 @@ node_modules
./secrets.nix
result
*.qcow2
-
+README.html
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..82c64ca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Welcome to *the Satellite*
+
+In case you are not familiar with nix/nixos, this is a collection of configuration files which build my entire system in a declarative manner. The tool used to configure the global system is called [nixos](https://nixos.org/), and the tool used to configure the individual users is called [home-manager](https://github.com/nix-community/home-manager).
+
+### Features this repository include:
+
+- Consistent base16 theming using [base16-nix](https://github.com/SenchoPens/base16.nix)
+- [Agenix](https://github.com/ryantm/agenix) & [homeage](https://github.com/jordanisaacs/homeage) based secret management
+- Sets up all the apps I use, including git, neovim, fish, tmux, starship, xmonad, rofi, polybar, discord, zathura, alacritty & more.
+
+### In the future I might start using any of the other cool nix-based tools, like:
+
+- [nix-darwin](https://github.com/LnL7/nix-darwin) - like nixos but for macs
+- [disko](https://github.com/nix-community/disko) - format disks using nix
+- [impernanence](https://github.com/nix-community/impermanence) - see the article about [erasing your darlings](https://grahamc.com/blog/erase-your-darlings)
+
+The current state of this repo is a refactor of my old, messy nixos config, based on the structure of [this template](https://github.com/Misterio77/nix-starter-configs).
+
+### Hosts
+
+This repo's structure is based on the concept of hosts - individual machines configured by me. I'm naming each host based on things in space/mythology (*they are the same picture*). The hosts I have right now are:
+
+- [tethys](./hosts/nixos) - my personal laptop
+
+### Points of interest
+
+Here's some things you might want to check out:
+
+- My [neovim config](./dotfiles/neovim)
+- The [flake](./flake.nix) entrypoint for this repository
diff --git a/dotfiles/neovim/lua/my/plugins/moonwalk.lua b/dotfiles/neovim/lua/my/plugins/moonwalk.lua
deleted file mode 100644
index d98a6ff..0000000
--- a/dotfiles/neovim/lua/my/plugins/moonwalk.lua
+++ /dev/null
@@ -1,20 +0,0 @@
-local M = {}
-
--- function M.setup()
- -- require("moonwalk").add_loader("tl", function(src, path)
- -- local tl = require("tl")
- -- local errs = {}
- -- local _, program = tl.parse_program(tl.lex(src), errs)
- --
- -- if #errs > 0 then
- -- error(
- -- path .. ":" .. errs[1].y .. ":" .. errs[1].x .. ": " .. errs[1].msg,
- -- 0
- -- )
- -- end
- --
- -- return tl.pretty_print_ast(program)
- -- end)
--- end
-
-return M
diff --git a/flake.nix b/flake.nix
index 4720160..aa74a8a 100644
--- a/flake.nix
+++ b/flake.nix
@@ -13,9 +13,9 @@
agenix.url = "github:ryantm/agenix";
agenix.inputs.nixpkgs.follows = "nixpkgs";
-# Homeage
- homeage.url = "github:jordanisaacs/homeage";
- homeage.inputs.nixpkgs.follows = "nixpkgs";
+ # Homeage
+ homeage.url = "github:jordanisaacs/homeage";
+ homeage.inputs.nixpkgs.follows = "nixpkgs";
# Base16-nix
base16.url = github:SenchoPens/base16.nix;