Add project structure info to README
This commit is contained in:
parent
e932e9b972
commit
d45b0f6e1a
1 changed files with 12 additions and 0 deletions
12
README.md
12
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.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue