Skip to content

Commit

Permalink
Document usage of multiple platforms (issue #85)
Browse files Browse the repository at this point in the history
See also issue #85 on GitHub:
  xolox/vim-session#85
  • Loading branch information
xolox committed Nov 11, 2014
1 parent 7a721b7 commit eaf2d44
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 7 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,10 @@ If the text formatting supported by the notes plug-in is not enough for you, con
" Enable Txtfmt formatting inside notes.
setlocal filetype=notes.txtfmt

## Using multiple platforms (multi boot, Cygwin, etc.)

Session scripts cannot be shared between platforms because they contain absolute pathnames that most certainly won't match between e.g. Windows and Linux or even Windows and Cygwin. The best you can do is keep separate session scripts for different platforms (and I would certainly consider Cygwin a separate platform altogether :-). For more information please refer to [issue #85] [issue_85].

## Contact

If you have questions, bug reports, suggestions, etc. the author can be contacted at <peter@peterodding.com>. The latest version is available at <http://peterodding.com/code/vim/notes/> and <http://github.com/xolox/vim-notes>. If you like the script please vote for it on [Vim Online] [vim_online].
Expand All @@ -351,6 +355,7 @@ This software is licensed under the [MIT license] [mit].
[github-misc]: http://github.com/xolox/vim-misc
[github-notes]: http://github.com/xolox/vim-notes
[highlight]: http://vimdoc.sourceforge.net/htmldoc/syntax.html#:highlight
[issue_85]: https://github.com/xolox/vim-session/issues/85
[levenshtein]: http://en.wikipedia.org/wiki/Levenshtein_distance
[mapleader]: http://vimdoc.sourceforge.net/htmldoc/map.html#mapleader
[markdown]: http://en.wikipedia.org/wiki/Markdown
Expand Down
27 changes: 20 additions & 7 deletions doc/notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,10 @@ Contents ~
2. shell.vim |notes-shell.vim|
3. VOoM |notes-voom|
4. Txtfmt |notes-txtfmt|
8. Contact |notes-contact|
9. License |notes-license|
10. References |notes-references|
8. Using multiple platforms (multi boot, Cygwin, etc.) |notes-using-multiple-platforms|
9. Contact |notes-contact|
10. License |notes-license|
11. References |notes-references|

===============================================================================
*notes-introduction*
Expand Down Expand Up @@ -662,20 +663,31 @@ profile with the following contents:
" Enable Txtfmt formatting inside notes.
setlocal filetype=notes.txtfmt
<
===============================================================================
*notes-using-multiple-platforms*
Using multiple platforms (multi boot, Cygwin, etc.) ~

Session scripts cannot be shared between platforms because they contain
absolute pathnames that most certainly won't match between e.g. Windows and
Linux or even Windows and Cygwin. The best you can do is keep separate session
scripts for different platforms (and I would certainly consider Cygwin a
separate platform altogether :-). For more information please refer to issue
#85 [17].

===============================================================================
*notes-contact*
Contact ~

If you have questions, bug reports, suggestions, etc. the author can be
contacted at peter@peterodding.com. The latest version is available at
http://peterodding.com/code/vim/notes/ and http://github.com/xolox/vim-notes.
If you like the script please vote for it on Vim Online [17].
If you like the script please vote for it on Vim Online [18].

===============================================================================
*notes-license*
License ~

This software is licensed under the MIT license [18]. © 2014 Peter Odding
This software is licensed under the MIT license [19]. © 2014 Peter Odding
<peter@peterodding.com>.

===============================================================================
Expand All @@ -698,7 +710,8 @@ References ~
[14] http://www.vim.org/scripts/script.php?script_id=3123
[15] http://www.vim.org/scripts/script.php?script_id=2657
[16] http://www.vim.org/scripts/script.php?script_id=2208
[17] http://www.vim.org/scripts/script.php?script_id=3375
[18] http://en.wikipedia.org/wiki/MIT_License
[17] https://github.com/xolox/vim-session/issues/85
[18] http://www.vim.org/scripts/script.php?script_id=3375
[19] http://en.wikipedia.org/wiki/MIT_License

vim: ft=help

0 comments on commit eaf2d44

Please sign in to comment.