avron/armacs
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
No description
119 commits 1 branch 0 tags 6.1 MiB
Org 99.9%
Find a file
Abraham Raji 354c976782 added web dev file
2020-01-11 18:46:12 +05:30
customsrc added time machine 2020-01-11 18:32:59 +05:30
img updated logo, fixed keybinding errors in config, added screenshot to readme 2019-07-24 17:53:55 +05:30
.gitignore added gitignore 2020-01-11 14:16:45 +05:30
config.org added web dev file 2020-01-11 18:46:12 +05:30
init.el Update init.el 2018-10-25 21:10:42 +05:30
LICENSE Create LICENSE 2019-07-16 07:34:45 +05:30
README.org Update README.org 2020-01-11 14:04:31 +05:30

README.org

Armacs

https://img.shields.io/badge/Made_for-Emacs_25.3+-blueviolet.svg?style=for-the-badge https://img.shields.io/badge/Version-Beta-blue.svg?style=for-the-badge

https://i.imgur.com/vunwoQ7.png

What is armacs?

Unlike Spacemacs or Doom Emacs, Armacs does not intend to be a drop in replacement for any mainstream text editor. Armacs is designed with a few things in mind:

  • Encourage understanding how emacs works and write their own config files.
  • Novice users of emacs wouldn't have to setup basic functionalities.
  • The config isn't too complicated so that users will be able to make changes to the config without breaking anything.
  • Armacs put first priority to proper documentaion so that the users know what each package/configuration does.

I'm not in a position to spent time on config files at the moment. What are my alternatives?

You are in luck. I have two great options for you. Check both out and pick what works for you:

  • Spacemacs : A community-driven Emacs distribution.
  • Doom Emacs : Doom is a configuration for GNU Emacs. It can be used as framework for your own configuration, or as a resource for fellow Emacs enthusiasts who want to learn more about our favorite OS

Installation

CLone this repo into your home folder if the folder is not named .emacs.d, rename the folder to .emacs.d.

  1. If you have an existing Emacs configuration, back it up first:

    cd ~
mv .emacs.d .emacs.d.bak
mv .emacs .emacs.bak

    Don't forget to backup and remove `~/.emacs` file otherwise armacs WILL NOT load since that file prevents Emacs from loading the proper initialization file.

  2. Clone the repository:

    git clone https://github.com/avronr/armacs ~/.emacs.d

  3. Switch to stable branch:

    git checkout master

Configuration

When Emacs is started, it normally tries to load a Lisp program from an “initialization file”, or “init file” for short. This file, if it exists, specifies how to initialize Emacs for you. Emacs looks for your init file using the filenames ‘~/.emacs’, ‘~/.emacs.el’, or ‘~/.emacs.d/init.el’. Here all the init.el file does is point to the config.org file. All of the actual configuration is done in the ~/.emacs.d/config.org file.

Contributing

You can fork the repo and make changes. As I said earlier, documentation is important here so whatever you do make sure you explain what you are doing or your change may not be accepted to the main repo.

Resources to learn Emacs

Youtube Playlists

Single Youtube Video

Blogs