Update readme and links
This commit is contained in:
27
README.org
27
README.org
@ -1,20 +1,26 @@
|
||||
#+TITLE: org-krita
|
||||
|
||||
[[tag][file:https://img.shields.io/github/v/tag/lepisma/org-krita.svg]]
|
||||
Fork of [[https://github.com/lepisma/org-krita][org-krita]] originally by [[https://github.com/lepisma][lepisma]].
|
||||
|
||||
Tweaks included:
|
||||
- Images are now extracted using the =org-krita-extract-filename= variable
|
||||
- Defaults to "mergedimage.png" (high fidelity)
|
||||
- Can be changed to "preview.png" (better performance)
|
||||
- All images are scaled according to the variable =org-krita-scale= (defaults to 1)
|
||||
- Editing now opens in krita's full mode by default
|
||||
|
||||
Minor mode for working with [[https://krita.org/en/][krita]] notes, sketches etc. in org mode.
|
||||
|
||||
[[file:./screen.gif]]
|
||||
|
||||
** Quickstart
|
||||
The package is not on melpa yet. For installing, I would recommend downloading
|
||||
the release tarballs from [[https://github.com/lepisma/org-krita/releases][here]]. Or if you are using [[https://github.com/quelpa/quelpa-use-package][quelpa-use-package]], you can
|
||||
The package is not on melpa yet. For installing, you can clone the repo and load manually. Or if you are using [[https://github.com/quelpa/quelpa-use-package][quelpa-use-package]], you can
|
||||
do the following:
|
||||
|
||||
#+begin_src emacs-lisp
|
||||
(use-package org-krita
|
||||
:ensure t
|
||||
:quelpa (org-krita :fetcher github :repo "lepisma/org-krita" :files ("*.el" "resources"))
|
||||
:quelpa (org-krita :fetcher github :repo "librephoenix/org-krita" :files ("*.el" "resources"))
|
||||
:config
|
||||
(add-hook 'org-mode-hook 'org-krita-mode))
|
||||
#+end_src
|
||||
@ -23,7 +29,7 @@ Or, if you are using Doom emacs you can add this to your =packages.el=:
|
||||
#+begin_src emacs-lisp
|
||||
(package! org-krita
|
||||
:recipe (:host github
|
||||
:repo "lepisma/org-krita"
|
||||
:repo "librephoenix/org-krita"
|
||||
:files ("resources" "resources" "*.el" "*.el")))
|
||||
#+end_src
|
||||
|
||||
@ -41,14 +47,3 @@ and this to your =config.el=:
|
||||
For using, you need to enable the minor mode =org-krita-mode= in org buffer with
|
||||
=krita= links like this =[[krita:./some-file.kra][image]]=. To create new files
|
||||
within the buffer itself, try calling =org-krita-insert-new-image=.
|
||||
|
||||
** Roadmap
|
||||
Here are the directions that need work (as far as I can think of right now):
|
||||
1. Making the package tool agnostic. This basically means abstracting out the
|
||||
following pieces that are tuned to krita at the moment:
|
||||
1. Function for creating new image in the tool's format.
|
||||
2. Function for extracting =png= from the file for inline display.
|
||||
3. Function for running the program to edit an image.
|
||||
2. Better inline display. Right now we bypass org's inline display which means
|
||||
we miss out on basic things like setting width and height for larger images
|
||||
and other goodies.
|
||||
|
@ -3,9 +3,10 @@
|
||||
;; Copyright (c) 2020 Abhinav Tushar
|
||||
|
||||
;; Author: Abhinav Tushar <abhinav@lepisma.xyz>
|
||||
;; Forked by: Emmet (LibrePhoenix) <emmet@librephoenix.com>
|
||||
;; Version: 0.2.1
|
||||
;; Package-Requires: ((emacs "26") (f "0.20.0") (org "9.3"))
|
||||
;; URL: https://github.com/lepisma/org-krita
|
||||
;; URL: https://github.com/librephoenix/org-krita
|
||||
|
||||
;;; Commentary:
|
||||
|
||||
|
Reference in New Issue
Block a user