aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 86c24d17191443f2a0aedc72f6d2e066c91655ad (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# MMOSMacs

MMOSMacs is the Emacs configuration for MMOS, which is currently just an
idea I have for an Emacs-centric Linux distribution. MMOSMacs is the
core of my computing experience, and is designed to be a
jack-of-all-trades just like me.


## Installation

First, clone this repository into your `~/.emacs.d` directory.
```bash
cd
git clone https://github.com/MountainMan1312/MMOSMacs.git .emacs.d
```

Next create symlinks to the `xinitrc` and `emacs.desktop` files so X
knows what to do:
```bash
# Backup your `.xinitrc` file if you feel like it.
# Replace `.xinitrc.old` with whatever you want to name the backup.
mv .xinitrc .xinitrc.old

# Symlink your `.xinitrc` file
ln -s .emacs.d/xinitrc .xinitrc

# Symlink `emacs.desktop` to add MMOSMacs as an entry to your Display
# Manager / login screen.
sudo ln -s .emacs.d/emacs.desktop /usr/share/xsessions/emacs.desktop
```


## Plans

- Non-literate configuration
- `straight.el` + `use-package` package management
- Emacs as a desktop environment (`EXWM`, `EDNC`)
- System & network administration suite
- Security & crytography
- Software development environment
- Communications (Email, RSS, IRC, Matrix, etc.)
- Opinionated PKMS and publishing suite
- Common desktop applications
    - Web browser, FTP, Torrent
    - Multimedia production
    - OpenSCAD / ImplicitCAD
    - Finance
    - Games
- Custom modeline & anti-distraction features
- Custom theme deisnged to reduce eye-strain
- Custom keybind system, menus, & dialogs


## Contributing

This is my personal project. I will do what I can to make it accessible
to other people, but ultimately it is crafted to suit my own needs.

If you want to contribute to MMOSMacs, please read `CONTRIBUTING.md`. If
you do not have a copy of this file, it can be found at either:
- https://github.com/MountainMan1312/MMOSMacs/blob/stable/README.md
- https://raw.githubusercontent.com/MountainMan1312/MMOSMacs/stable/README.md

Feel free to fork this repository. There is no need to give me credit.
It is wrong to claim ownership of knowledge.