mirror of
https://github.com/olivierkes/manuskript.git
synced 2024-05-18 20:02:32 +12:00
Updated Home (markdown)
parent
0d7add2979
commit
3dcc65d4d5
59
Home.md
59
Home.md
|
@ -1,64 +1,57 @@
|
|||
# HowTo's
|
||||
# Installing
|
||||
|
||||
## Installing
|
||||
|
||||
### Install Binary (_Easier_)
|
||||
## Install Binary (_Easier_)
|
||||
* [Manuskript Download](http://www.theologeek.ch/manuskript/download/)
|
||||
* [Alternate Manuskript Download](https://sourceforge.net/projects/manuskript/files/manuskript/)
|
||||
* **TIP**: Install [pandoc](https://pandoc.org/installing.html) for more export document formats such as ePub, OpenDocument (LibreOffice), and DocX (MS Word).
|
||||
|
||||
### Install Source Code (_More Work, Runs on More OS Platforms_)
|
||||
## Install Source Code (_More Work, Runs on More OS Platforms_)
|
||||
* [[Run Manuskript from Source Code on Linux]]
|
||||
* [[Run Manuskript from Source Code on Windows]]
|
||||
* [[Run Manuskript from Source Code on Mac OS X|Run manuskript on OS X]]
|
||||
|
||||
## Using
|
||||
# Using
|
||||
|
||||
### General
|
||||
## How To...
|
||||
* [[How to start a new project]]
|
||||
* [How to Use Manuskript to Write a Fiction Novel](http://gedakc.users.sourceforge.net/display-doc.php?name=manuskript-novel-writing)
|
||||
* [[How to keep track of important items]]
|
||||
* [[How to Add a Spellcheck Language Dictionary|Adding a Spellcheck Language Dictionary to Manuskript]]
|
||||
* [[How to run manuskript globally, from anywhere]] (Linux)
|
||||
|
||||
* [Using Manuskript to Write a Fiction Novel](http://gedakc.users.sourceforge.net/display-doc.php?name=manuskript-novel-writing)
|
||||
## Overview
|
||||
* [[Overview of Manuskript Panes]]
|
||||
* [[Overview of Manuskript Right Sidebar]]
|
||||
* [[Overview of Manuskript Menu]]
|
||||
* [[Overview of Manuskript Settings]]
|
||||
* [[How to start a new project]]
|
||||
* [[Import and Export capabilities]]
|
||||
* [[Fullscreen mode|Full-screen-mode]]
|
||||
* [[How to keep track of important items]]
|
||||
* [[Adding a Spellcheck Language Dictionary|Adding a Spellcheck Language Dictionary to Manuskript]]
|
||||
* [[Documentation Snippets]] - Split Scenes
|
||||
* See [answered questions](https://github.com/olivierkes/manuskript/issues?utf8=%E2%9C%93&q=+label%3Aquestion+) in the issues tracker
|
||||
|
||||
## Features
|
||||
* [[Keyboard Shortcuts]]
|
||||
* See [a list of answered questions](https://github.com/olivierkes/manuskript/issues?utf8=%E2%9C%93&q=+label%3Aquestion+) in the issues tracker
|
||||
* [[Fullscreen mode]]
|
||||
* [[Documentation Snippets]]
|
||||
* [[Import and Export capabilities]]
|
||||
|
||||
### Linux
|
||||
# Mission Statement
|
||||
|
||||
* [[How to run manuskript globally, from anywhere]]
|
||||
The goal of Manuskript is to ease the task of writing large projects by providing facilities to stay organized and track details, while also keeping distractions to a minimum.
|
||||
|
||||
## Future Plans
|
||||
To maximize flexibility an open and plain text file format is used enabling collaboration with third-party tools.
|
||||
|
||||
* [[Roadmap]]
|
||||
For future plans, see the [[Roadmap]].
|
||||
|
||||
## Mission Statement
|
||||
# Contributing
|
||||
|
||||
The goal of Manuskript is to ease the task of writing large projects
|
||||
by providing facilities to stay organized and track details, while
|
||||
also keeping distractions to a minimum.
|
||||
|
||||
To maximize flexibility an open and plain text file format is used
|
||||
enabling collaboration with third-party tools.
|
||||
|
||||
## Contributing
|
||||
|
||||
### Developing
|
||||
## Developing
|
||||
|
||||
* All code changes and Pull Requests should be based on the **develop** branch.
|
||||
Tip: Add `--console` as last option on command line to use [IPython Jupyter QT Console as a debugging aid](https://github.com/olivierkes/manuskript/pull/513).
|
||||
|
||||
### Translating
|
||||
## Translating
|
||||
|
||||
* [[Translate Manuskript]] in a new language, or update existing translation
|
||||
|
||||
### Packaging (for release package file)
|
||||
## Packaging (for release package file)
|
||||
|
||||
* [[Package Manuskript for Linux with dpkg]] --> .deb
|
||||
* [[Package Manuskript for Linux with rpm]] --> .rpm
|
||||
|
@ -70,6 +63,6 @@ enabling collaboration with third-party tools.
|
|||
* [[[Packaging]-Generate-Windows-binaries-with-pyInstaller-(HowTo)|[Packaging]-Generate-Windows-binaries-with-pyInstaller-(HowTo)]] - **NOTE: _Older HowTo_**
|
||||
* [[Creating manuskript binary for Android and IOS]] - **_Help Wanted_**
|
||||
|
||||
### Releasing Official Version
|
||||
## Releasing Official Version
|
||||
|
||||
* [[Steps To Create An Official Manuskript Release]]
|
Loading…
Reference in a new issue