From a77779acb7e83deba0e6d0b730d41c320dd99c39 Mon Sep 17 00:00:00 2001 From: Katharina Fey Date: Sun, 21 Nov 2021 23:21:09 +0100 Subject: [PATCH] novelist: update README to be written in org --- apps/novelist-mode.el/README.md | 58 -------------------------------- apps/novelist-mode.el/README.org | 53 +++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 58 deletions(-) delete mode 100644 apps/novelist-mode.el/README.md create mode 100644 apps/novelist-mode.el/README.org diff --git a/apps/novelist-mode.el/README.md b/apps/novelist-mode.el/README.md deleted file mode 100644 index c3f4cc9b4c3..00000000000 --- a/apps/novelist-mode.el/README.md +++ /dev/null @@ -1,58 +0,0 @@ -
- -
- -
-

novelist-mode.el

-
- -
- -
- -
- -An emacs major mode for writing novels, short stories, and other forms -of prose. novelist-mode manages your projects data files, chapter -layouts, and additional story metadata. Supports externally linked -universes, to allow sharing notes between projects. - -Emacs is a extensible free software text editor, providing the engine -for novelist-mode. - - -## Features - -novelist-mode helps you manage your projects and story resources. It -uses interactive menus in emacs to achieve this. All functions are -also directly callable, to be used in your own keybindings. - -- `novelist-project-create` create a new project structure on disk -- `novelist-add (type, name, path)` add a new resource to the project -- `novelist-delete (path, &optional purge)` soft-remove a resource - from the project, moving it to trash, or optionally actually - deleting it. -- `novelist-path-overview` toggle the project explorer sidebar -- `novelist-path-notes (&optional path)` show note buffer for selected - path (or any other if given the argument) -- `novelist-path-metadata (&optional path)` show metadata panel for - selected path (or any other) - - -## Overview - -A project is structured into chapter and scenes. When exporting a -section, all children will be concatinated according to the export -config (for example put ` - *** - ` separator between sections). - -Additionally to the main script part of your project there are -associated resources available. When writing, you might want to swap -out parts, build alternative timelines to see which one might play -better, or just have notes on your characters and universe. When -adding a resource you will be asked for a template (or blank). When -creating a templated resource, it will be sorted into the appropriate -category (for example characters, or place-descriptions). These parts -will not be exported from your project, even when you select the -entire project for export. - - diff --git a/apps/novelist-mode.el/README.org b/apps/novelist-mode.el/README.org new file mode 100644 index 00000000000..71999a7d3e3 --- /dev/null +++ b/apps/novelist-mode.el/README.org @@ -0,0 +1,53 @@ + + +[[file:assets/novelist.png]] + +#+OPTIONS: toc:nil, num:nil + +* novelist-mode + + An emacs major mode for **writing novels, short stories, and other + forms of prose**. novelist-mode manages your projects data files, + chapter layouts, and additional story metadata. Supports externally + linked universes, to allow sharing notes between projects. + + Emacs is a extensible free software text editor, providing the + engine for *novelist-mode*. + +** Features + + *novelist-mode* helps you manage your projects and story resources. + It uses interactive menus in emacs to achieve this. All functions + are also directly callable, to be used in your own keybindings. + + - `novelist-project-create` create a new project structure on disk + - `novelist-add (type, name, path)` add a new resource to the project + - `novelist-delete (path, &optional purge)` soft-remove a resource + from the project, moving it to trash, or optionally actually + deleting it. + - `novelist-path-overview` toggle the project explorer sidebar + - `novelist-path-notes (&optional path)` show note buffer for selected + path (or any other if given the argument) + - `novelist-path-metadata (&optional path)` show metadata panel for + selected path (or any other) + + +* Overview + + A project is structured into chapter and scenes. When exporting a + section, all children will be concatinated according to the export + config (for example put ` - *** - ` separator between sections). + + Additionally to the main script part of your project there are + associated resources available. When writing, you might want to + swap out parts, build alternative timelines to see which one might + play better, or just have notes on your characters and universe. + When adding a resource you will be asked for a template (or blank). + When creating a templated resource, it will be sorted into the + appropriate category (for example characters, or + place-descriptions). These parts will not be exported from your + project, even when you select the entire project for export. + + Following is a picture of an early demo of *novelist-mode*! + +[[file:assets/early-demo.png]]