about summary refs log tree commit diff stats
path: root/archive/2.vm/edit/Readme.md
diff options
context:
space:
mode:
authorKartik Agaram <vc@akkartik.com>2020-01-01 17:04:37 -0800
committerKartik Agaram <vc@akkartik.com>2020-01-01 17:04:37 -0800
commit2a4088119cf41175457414dfa59bd4064b8f0562 (patch)
tree64fe184e399f9870ebd481a90eec34d51e5dff68 /archive/2.vm/edit/Readme.md
parent23fd294d85959c6b476bcdc35ed6ad508cc99b8f (diff)
downloadmu-2a4088119cf41175457414dfa59bd4064b8f0562.tar.gz
5852
Diffstat (limited to 'archive/2.vm/edit/Readme.md')
-rw-r--r--archive/2.vm/edit/Readme.md49
1 files changed, 0 insertions, 49 deletions
diff --git a/archive/2.vm/edit/Readme.md b/archive/2.vm/edit/Readme.md
deleted file mode 100644
index 698e534b..00000000
--- a/archive/2.vm/edit/Readme.md
+++ /dev/null
@@ -1,49 +0,0 @@
-Environment for learning programming using Mu: http://akkartik.name/post/mu
-
-Run it from the `mu` directory:
-
-  ```shell
-  $ ./mu edit
-  ```
-
-This will load all the `.mu` files in this directory and then run the editor.
-Press ctrl-c to quit. Press F4 to save your work (if a lesson/ directory
-exists) and to run the contents of the sandbox editor on the right.
-
-You can also run the tests for the environment:
-
-  ```shell
-  $ ./mu test edit
-  ```
-
-You can also load the files more explicitly by enumerating them all (in order):
-
-  ```shell
-  $  ./mu edit/*.mu
-  ```
-
-This is handy if you want to play with simpler versions of the editor that are
-easier to understand. Stop loading at any layer to run with a subset of
-features:
-
-  ```shell
-  $ ./mu edit/001*.mu edit/002*.mu  # run a simple editor rather than the full environment
-  ```
-
----
-
-Appendix: keyboard shortcuts
-
-  _moving and scrolling_
-  - `ctrl-a` or `home`: move cursor to start of line
-  - `ctrl-e` or `end`: move cursor to end of line
-  - `ctrl-f` or `page-down`: scroll down by one page
-  - `ctrl-b` or `page-up`: scroll up by one page
-  - `ctrl-x`: scroll down by one line
-  - `ctrl-s`: scroll up by one line
-  - `ctrl-t`: scroll until current line is at top of screen
-
-  _modifying text_
-  - `ctrl-k`: delete text from cursor to end of line
-  - `ctrl-u`: delete text from start of line until just before cursor
-  - `ctrl-/`: comment/uncomment current line (using a special leader to ignore real comments https://www.reddit.com/r/vim/comments/4ootmz/_/d4ehmql)
-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
Guidelines on Code Modification
===============================

Coding Style
------------

* Use syntax compatible to both python 2.6 and 3.1.
* Use docstrings with pydoc in mind
* Follow the style guide for python code:
    http://www.python.org/dev/peps/pep-0008/
* Although this guide suggests otherwise, tabs are used for indentation
    of code and docstrings.  In other documents (readme, etc), use spaces.


Patches
-------

Send patches, created with "git format-patch", to the email adress

    romanz@lavabit.com

If you plan to do major changes, or many changes over time, I encourage
you to create a fork on GitHub, Gitorious or any other site.


Common Changes
--------------

* Change which files are previewed in the auto preview:
In ranger/gui/widget/browsercolumn.py
the constant PREVIEW_BLACKLIST

* Adding options:
In ranger/defaults/options.py
add the default value, like: my_option = True
In ranger/shared/settings.py
add the name of your option to the constant ALLOWED_SETTINGS

The setting is now accessible at self.settings.my_option,
assuming <self> is a "SettingsAware" object.

* Change commands:
ranger/defaults/commands.py

* Create aliases for commands:
In ranger/defaults/commands.py
at the bottom, write something like: alias(exit=quit)

* Adding colorschemes:
Copy ranger/colorschemes/default.py to ranger/colorschemes/myscheme.py
and modify it according to your needs.  Alternatively, mimic the jungle
colorscheme.  It subclasses the default scheme and just modifies a few things.
In ranger/defaults/options.py (or ~/.ranger/options.py), change
    colorscheme = colorschemes.default
to: colorscheme = colorschemes.myscheme

* Change which files are considered to be "hidden":
In ranger/defaults/options.py
change the hidden_filter regular expression.

* Change the key map:
Modify ranger/defaults/keys.py.  This should be self-explanatory.
Check out ranger/core/actions.py for the most common actions, of course
you can also use your own functions.

* Change the file type => application associations:
In ranger/defaults/apps.py
modify the method app_default.
The variable "f" is a filesystem-object with attributes like mimetype,
extension, etc.  For a full list, check ranger/fsobject/fsobject.py

* Change the file extension => mime type associations:
Modify ranger/data/mime.types
and run ranger/data/generate.py to compile it.


Version Numbering
-----------------

X.Y.Z, where:

* X: Milestones
* Y: Stable versions
* Z: Experimental versions