Update 'README.md'
This commit is contained in:
parent
03a612bfc0
commit
f09aab9f82
1 changed files with 3 additions and 5 deletions
|
@ -1,6 +1,6 @@
|
|||
# Ficdown
|
||||
|
||||
Ficdown is a system for building interactive fiction using MarkDown syntax. See [Ficdown.com](http://www.ficdown.com) for more information.
|
||||
Ficdown is a system for building interactive fiction using MarkDown syntax.
|
||||
|
||||
This project contains the core Ficdown library for parsing Ficdown stories, as well as a console application that can be used to generate HTML or epub ebook formats.
|
||||
|
||||
|
@ -10,7 +10,7 @@ Ficdown is written using .NET Core and should run on Windows, Linux, and OSX wit
|
|||
|
||||
## Obtaining
|
||||
|
||||
If you want to use Ficdown to convert your stories into ebooks, download the latest version from the [releases](https://github.com/rudism/Ficdown/releases) page and decompress it somewhere on your hard drive. Ficdown does not include an installer, the application and all of its dependencies are included directly in the zip archive.
|
||||
If you want to use Ficdown to convert your stories into ebooks, download the latest version from the [releases](https://code.sitosis.com/rudism/ficdown/releases) page and decompress it somewhere on your hard drive. Ficdown does not include an installer, the application and all of its dependencies are included directly in the zip archive.
|
||||
|
||||
## Usage
|
||||
|
||||
|
@ -87,10 +87,8 @@ To generate other formats than HTML or epub, you will have to use third party to
|
|||
|
||||
## Additional Tools
|
||||
|
||||
- Ficdown stories can be played interactively in a web browser without even requiring the command line utility here. See [Ficdown.js](https://github.com/rudism/Ficdown.js) for a Javascript Ficdown parser and interpreter that you can include on your own website to present your Ficdown stories.
|
||||
- Ficdown stories can be played interactively in a web browser without even requiring the command line utility here. See [Ficdown.js](https://code.sitosis.com/rudism/ficdown.js) for a Javascript Ficdown parser and interpreter that you can include on your own website to present your Ficdown stories.
|
||||
|
||||
- [Ficdown-editor](https://byfernanz.github.io/ficdown-editor/) is a web-based GUI for writing Ficdown.
|
||||
|
||||
- [Prop](https://github.com/ByFernanz/prop) is a YAML-header style preprocessor for Ficdown
|
||||
|
||||
- [vim-ficdown](https://github.com/rudism/vim-ficdown) is an ALE linter for vim that identifies things like links to scenes that don't exist, unused variables, and other errors and warnings in Ficdown files.
|
||||
|
|
Loading…
Reference in a new issue