diff options
author | Mountain Man <mmosmacs-dev@anu.tgwil.net> | 2023-04-04 02:47:09 -0400 |
---|---|---|
committer | Mountain Man <mmosmacs-dev@anu.tgwil.net> | 2023-04-04 02:47:09 -0400 |
commit | 08f856b490af73d80fb2b5a92030d4fa2b9273a8 (patch) | |
tree | a03b5daf3d3b12fa78a610afc0990f88a629c865 | |
parent | Initial commit (diff) | |
download | mmosmacs-08f856b490af73d80fb2b5a92030d4fa2b9273a8.tar.gz mmosmacs-08f856b490af73d80fb2b5a92030d4fa2b9273a8.tar.bz2 mmosmacs-08f856b490af73d80fb2b5a92030d4fa2b9273a8.zip |
Write the initial `README.md`
Every good project needs a `README.md` file. This document summarizes
MMOSMacs, outlines my plans for the project, and directs contributors to
the `CONTRIBUTING.md` file (which hasn't been written yet, that's next
on my TODO list).
-rw-r--r-- | README.md | 43 |
1 files changed, 42 insertions, 1 deletions
@@ -1 +1,42 @@ | |||
1 | # MMOSMacs \ No newline at end of file | 1 | # MMOSMacs |
2 | |||
3 | MMOSMacs is the Emacs configuration for MMOS, which is currently just an | ||
4 | idea I have for an Emacs-centric Linux distribution. MMOSMacs is the | ||
5 | core of my computing experience, and is designed to be a | ||
6 | jack-of-all-trades just like me. | ||
7 | |||
8 | MMOSMacs is currently in the planning phase. | ||
9 | |||
10 | |||
11 | ## Plans | ||
12 | |||
13 | - Modular non-literate configuration | ||
14 | - `straight.el` + `use-package` package management | ||
15 | - Emacs as a desktop environment (`EXWM`, `EDNC`) | ||
16 | - System & network administration suite | ||
17 | - Security & crytography | ||
18 | - Software development environment | ||
19 | - Communications (Email, RSS, IRC, Matrix, etc.) | ||
20 | - Opinionated PKMS and publishing suite | ||
21 | - Common desktop applications | ||
22 | - Web browser, FTP, Torrent | ||
23 | - Multimedia production | ||
24 | - OpenSCAD / ImplicitCAD | ||
25 | - Finance | ||
26 | - Games | ||
27 | - Custom modeline & anti-distraction features | ||
28 | - Custom theme deisnged to reduce eye-strain | ||
29 | - Custom keybinds, menus, & dialogs | ||
30 | |||
31 | ## Contributing | ||
32 | |||
33 | This is my personal project. I will do what I can to make it accessible | ||
34 | to other people, but ultimately it is crafted to suit my own needs. | ||
35 | |||
36 | If you want to contribute to MMOSMacs, please read `CONTRIBUTING.md`. If | ||
37 | you do not have a copy of this file, it can be found at either: | ||
38 | - https://github.com/MountainMan1312/MMOSMacs/blob/stable/README.md | ||
39 | - https://raw.githubusercontent.com/MountainMan1312/MMOSMacs/stable/README.md | ||
40 | |||
41 | Feel free to fork this repository. There is no need to give me credit. | ||
42 | It is wrong to claim ownership of knowledge. | ||