Commit Diff


commit - b254082a016c2d8d281dcc0469dfe14e803353cc
commit + 8fe7904adf98d3d139b55e9f5bcebd7ed563d5a4
blob - e1d34464a4ec91eb08a2b2c53e902d4474412857 (mode 644)
blob + /dev/null
--- README
+++ /dev/null
@@ -1,49 +0,0 @@
-Introduction
-============
-
- Rover is an interactive application for file system navigation. The
-main goal is to provide a faster way to explore a file system from the
-terminal, compared to what's possible by using `cd`, `ls`, etc. Rover
-is designed to be simple and portable. It was originally written to be
-used on a headless Raspberry Pi accessed via ssh. The Ranger file manager
-(http://ranger.nongnu.org/) was a major inspiration for the user interface
-design, but Rover has significantly less features and dependencies.
-
-
-Quick Start
-===========
-
- Building:
- $ make
-
- Running:
- $ ./rover
-
- Using:
-       q - quit Rover
-     j/k - move cursor up/down
-     J/K - move cursor up/down 10 times
-       l - enter selected directory
-       h - go to parent directory
-       H - go to $HOME directory
-  RETURN - open $SHELL on the current directory
-   SPACE - open $PAGER on the selected file
-       e - open $EDITOR on the selected file
-       / - start incremental search (RETURN to finish)
-       f - toggle file listing
-       d - toggle directory listing
-       s - toggle hidden file/directory listing
-
-
-Configuration
-=============
-
- Rover configuration (mostly key bindings and colors) can only be changed
-by editing config.h and rebuilding the binary.
-
-
-Copyright
-=========
-
- All of the code and documentation in Rover has been dedicated to the
-   public domain.
blob - /dev/null
blob + c0d26e2ad2f6ab6252e8cdc9a17d39476cbc0a5c (mode 644)
--- /dev/null
+++ README.md
@@ -0,0 +1,55 @@
+Introduction
+============
+
+ Rover is an interactive application for file system navigation. The
+main goal is to provide a faster way to explore a file system from the
+terminal, compared to what's possible by using `cd`, `ls`, etc. Rover
+is designed to be simple and portable. It was originally written to be
+used on a headless Raspberry Pi accessed via ssh. The [Ranger file manager](http://ranger.nongnu.org/)
+was a major inspiration for the user interface design, but Rover has
+significantly less features and dependencies.
+
+
+Quick Start
+===========
+
+ Building:
+ ```
+ $ make
+ ```
+
+ Running:
+ ```
+ $ ./rover
+ ```
+
+ Using:
+ ```
+       q - quit Rover
+     j/k - move cursor up/down
+     J/K - move cursor up/down 10 times
+       l - enter selected directory
+       h - go to parent directory
+       H - go to $HOME directory
+  RETURN - open $SHELL on the current directory
+   SPACE - open $PAGER on the selected file
+       e - open $EDITOR on the selected file
+       / - start incremental search (RETURN to finish)
+       f - toggle file listing
+       d - toggle directory listing
+       s - toggle hidden file/directory listing
+ ```
+
+
+Configuration
+=============
+
+ Rover configuration (mostly key bindings and colors) can only be changed
+by editing config.h and rebuilding the binary.
+
+
+Copyright
+=========
+
+ All of the code and documentation in Rover has been dedicated to the
+   public domain.