OSDN Git Service

Update documents
[xkeymacs/xkeymacs.git] / Readme.txt
index e740ef2..feea145 100644 (file)
@@ -11,26 +11,25 @@ Install
 -------\r
 1. Install the following runtime libraries. The latter is necessary\r
    only on 64bit versions of Windows.\r
-   - Microsoft Visual C++ 2010 Redistributable Package (x86)\r
-     <http://tinyurl.com/vc2010x86>\r
-   - Microsoft Visual C++ 2010 Redistributable Package (x64)\r
-     <http://tinyurl.com/vc2010x64>\r
-2. Get a zip file from the following site.\r
-   <http://sourceforge.jp/projects/xkeymacs/releases/>\r
-3. Extract a directory containing XKeymacs from the zip file.\r
-4. Move the directory in an appropriate directory.\r
-5. Run xkeymacs.exe in the directory.\r
+   - Visual C++ Redistributable for Visual Studio 2015 (x86)\r
+     <http://tinyurl.com/vc2015x86>\r
+   - Visual C++ Redistributable for Visual Studio 2015 (x64)\r
+     <http://tinyurl.com/vc2015x64>\r
+2. Extract the zip archive to an appropriate folder.\r
 \r
 Upgrade or Uninstall\r
 --------------------\r
 1. Disable the "Auto Run" option of XKeymacs.\r
-2. Exit XKeymacs as mentioned below.\r
-3. Logoff or reboot windows.\r
+2. Reboot windows.\r
 \r
-   If you want to upgrade XKeymacs, you can follow the install instruction.\r
+  On upgrade\r
 \r
-4. Delete the directory containing XKeymacs.\r
-5. Run regedit and delete the following values:\r
+3. Overwrite the existing files with the files in the zip of new version.\r
+\r
+On uninstall\r
+\r
+3. Delete the directory containing XKeymacs.\r
+4. Run regedit and delete the following values:\r
 \r
         HKEY_CURRENT_USER\Software\oishi\XKeymacs\r
         HKEY_CURRENT_USER\Software\oishi\XKeymacs2\r
@@ -38,49 +37,49 @@ Upgrade or Uninstall
 \r
 Usage\r
 -----\r
+\r
 ### Run and exit\r
 \r
 Run xkeymacs.exe. It automatically run xkeymacs64.exe on 64bit\r
 versions of Windows. The gold key icon appears in the notification\r
-area of the taskbar when XKeymacs is running.\r
+area when XKeymacs is running.\r
 \r
-Right-click the gold (or silver) key icon, and select Exit from the\r
-pop up menu.\r
+To exit XKeymacs, right-click the gold (or silver) key icon, and\r
+select Exit in the pop up menu.\r
 \r
 ### Properties\r
 \r
 Right-click the gold key icon and select "Properties...", you can\r
 set key assigns per application.\r
 \r
-Properties dialog has three tabs: Basic, Advanced and List tab.\r
-The same configuration is shown by a different format in each tab.\r
-In Basic tab, you can configure whether or not each key combination\r
-works like Emacs. In Advanced tab, you can configure keys\r
-assignments for each command. In Lis tab, you can take a look at the\r
-configuration.\r
+Properties dialog has three tabs: Basic, Advanced and List. The same\r
+configuration is shown by different formats in these tabs.  In Basic\r
+tab, you can configure whether or not each key combination works\r
+like Emacs. In Advanced tab, you can configure keys assignments for\r
+each command. In Lis tab, you can take a look at the configuration.\r
 \r
 ### Import and export properties\r
 \r
 Select "Import Properties...", you can import an exported file.\r
 Select "Export Properties...", you can export the configuration under the\r
 following registry key to a file. \r
-**These features do not currently work on Windows 7.**\r
+**These features do not currently work.**\r
 \r
     HKEY_CURRENT_USER\Software\Oishi\XKeymacs2\r
 \r
 ### Options\r
 \r
 Select "Options...", you can set whether or not:\r
-1. run XKeymacs when you logon Windows.\r
-2. enable file completion on the Command Prompt.\r
-3. display C-x-, Shift, Ctrl and Alt LED in the notification area.\r
+1. run XKeymacs when you logon Windows\r
+2. enable file completion on the Command Prompt\r
+3. display C-x-, Shift, Ctrl and Alt LED in the notification area\r
 \r
 ### Keyboard layout\r
 \r
 Select "Keyboard Layout...", you can modify the keyboard layout.\r
 Drag & drop a key from the base keyboard to the remapped keyboard.\r
 The dropped key turns red. You can cancel the remap by clicking the red key.\r
-**This feature does not currently work on Windows 7.**\r
+**This feature does not currently work.**\r
 \r
 XKeymacs only uses the feature of remapping scan codes provided by Windows,\r
 so the remapping is not canceled after you disable or uninstall XKeymacs.\r
@@ -90,13 +89,19 @@ value by regedit.
     HKEY_CURRENT_USER\Keyboard Layout\Scancode Map\r
     HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Keyboard Layout\Scancode Map\r
 \r
+### Others\r
+\r
+Select "Disable" or "Enable" in the right-click menu when you\r
+disable or enable XKeymacs. You can toggle with C-q, too. Select\r
+"Reset" when XKeymacs becomes not effective by some chance.\r
+\r
 Support\r
 -------\r
 Web site\r
-<http://xkeymacs.sourceforge.jp/>\r
+<http://xkeymacs.osdn.jp/>\r
 \r
 Mailing list\r
-<http://lists.sourceforge.jp/mailman/listinfo/xkeymacs-users-en>\r
+<https://lists.osdn.me/mailman/listinfo/xkeymacs-users-en>\r
 \r
 Copyright\r
 ---------\r
@@ -104,7 +109,7 @@ Oishi-san <oishi@cam.hi-ho.ne.jp> owns the copyright of the code
 derived from XKeymacs 3.48.\r
 The following developers have the copyrights of their contributions.\r
 \r
-* Kazuhiro Fujieda <fujieda@users.sourceforge.jp>\r
+* Kazuhiro Fujieda <fujieda@users.osdn.me>\r
 * Tomohiro Kashiwada <kikairoya@gmail.com>\r
 * Harold Bamford <hbamford@users.sourceforge.net>\r
 * co <cogood@gmail.com>\r
@@ -134,4 +139,4 @@ We thank Oishi-san for creating XKeymacs and continuing to develop
 it for long years.\r
 \r
 ---\r
-Kazuhiro Fujieda <fujieda@users.sourceforge.jp>\r
+Kazuhiro Fujieda <fujieda@users.osdn.me>\r