From d45b0f6e1a62cc7e696514d344919e6abd87cf14 Mon Sep 17 00:00:00 2001
From: developomp <developomp@gmail.com>
Date: Sun, 26 Jun 2022 00:08:55 +0900
Subject: [PATCH] Add project structure info to README

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index e1f05e3..de720a0 100644
--- a/README.md
+++ b/README.md
@@ -64,6 +64,8 @@
 
 ## Overview
 
+### Software
+
 |                 Software | Choice                                                                                     |
 | -----------------------: | :----------------------------------------------------------------------------------------- |
 | Desktop Environment - 🚀 | [GNOME](https://www.gnome.org)                                                             |
@@ -74,6 +76,16 @@
 |             Browser - 🌐 | [Brave](https://github.com/brave/brave-browser)                                            |
 |   Text Editor & IDE - 📝 | [VSCodium](https://github.com/VSCodium/vscodium)                                           |
 
+### Project structure
+
+- `.github/workflows/deploy.yml` - A [github action](https://github.com/features/actions) that makes `setup.py` available at https://setup.developomp.com/
+- `.repo` - Extraneous files that does not serve any functional purpose
+- `etc` - Files that are copied over to the `/etc` directory
+- `home` - Files that are copied over to the `/home/pomp` directory
+- `files` - Files that are used but does not get copied
+  - `dconf` - [dconf](https://wiki.gnome.org/Projects/dconf) files
+- `src` - Python scripts. Check code comments (especially `__init__.py`) for more info
+
 ## Usage
 
 1. Install Arch linux.