From 08f856b490af73d80fb2b5a92030d4fa2b9273a8 Mon Sep 17 00:00:00 2001 From: Mountain Man Date: Tue, 4 Apr 2023 02:47:09 -0400 Subject: 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). --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 89256f1..4a9bfdb 100644 --- a/README.md +++ b/README.md @@ -1 +1,42 @@ -# MMOSMacs \ No newline at end of file +# 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. + +MMOSMacs is currently in the planning phase. + + +## Plans + +- Modular 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 keybinds, 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. -- cgit v1.2.3