~brettgilio/org-webring

Rewrite README in Org v1 APPLIED

Ivan Sokolov: 1
 Rewrite README in Org

 3 files changed, 76 insertions(+), 52 deletions(-)
Export patchset (mbox)
How do I use this?

Copy & paste the following snippet into your terminal to import this patchset into git:

curl -s https://lists.sr.ht/~brettgilio/org-webring/patches/12035/mbox | git am -3
Learn more about email & git
View this thread in the archives

[PATCH] Rewrite README in Org Export this patch

---
 README     | 52 ----------------------------------------------------
 README.md  | 41 +++++++++++++++++++++++++++++++++++++++++
 README.org | 35 +++++++++++++++++++++++++++++++++++
 3 files changed, 76 insertions(+), 52 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md
 create mode 100644 README.org

diff --git a/README b/README
deleted file mode 100644
index 6a35166..0000000
--- a/README
@@ -1,52 +0,0 @@
org-webring.el --- Generate webrings for Org-based sites/blogs

Copyright (C) 2020 Brett Gilio
Copyright (C) 2020 Alexandru-Sergiu Marton
Copyright (C) 2020 Jamie Beardslee
Copyright (C) 2020 Amin Bandali
Copyright (C) 2020 Ivan Sokolov

Author: Brett Gilio <brettg@gnu.org>
Co-author: Alexandru-Sergiu Marton <brown121407@posteo.ro>
Co-author: Jamie Beardslee <jdb@jamzattack.xyz>
Co-author: Amin Bandali <bandali@gnu.org>
Co-author: Ivan Sokolov <ivan-p-sokolov@ya.ru>
Version: 0.6

Repository: https://git.sr.ht/~brettgilio/org-webring
Tracker: https://todo.sr.ht/~brettgilio/org-webring
Mailing List: https://lists.sr.ht/~brettgilio/org-webring

This file is not currently part of GNU Emacs.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 3, or (at
your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

Commentary:

Org-webring is an alternative implementation of a feed-based webring,
taking inspiration from `openring' by Drew DeVault.  Intended to
integrate with Org-based websites and blogs (either directly, or
indirectly, as in ox-hugo), it will fetch a given list of web feed
files and correctly parse and format the elements to be displayed for
sharing.

The CSS file `org-webring.css' needs to be loaded by your website, and
your browser must be able to render flex boxes.

The file `ring.org' is a template.  Copy it into a specified directory
from where your website is generated.  Add all relevant web feed URLs
to `org-webring-urls' for fetching.

To include the results of `ring.org' into an Org file export of your
choosing, simply add: "#+INCLUDE: ./ring.org", taking care to modify
the path appropriately.  When you regenerate your Org-based (or Hugo,
using ox-hugo) website, the function `org-webring-generate-webring'
will be evaluated and the result will be displayed.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dffebac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@


# org-webring

Generate webrings for Org-based sites blogs.

Org-webring is an alternative implementation of a feed-based
webring, taking inspiration from [openring](https://git.sr.ht/~sircmpwn/openring) by Drew DeVault. Intended
to integrate with Org-based websites and blogs (either directly, or
indirectly, as in ox-hugo), it will fetch a given list of web feed
files and correctly parse and format the elements to be displayed
for sharing.


## Usage

The CSS file `org-webring.css` needs to be loaded by your website,
and your browser must be able to render flex boxes.

The file `ring.org` is a template. Copy it into a specified
directory from where your website is generated. Add all relevant web
feed URLs to `org-webring-urls` for fetching.

To include the results of `ring.org` into an Org file export of your
choosing, simply add: `#+INCLUDE: ./ring.org`, taking care to modify
the path appropriately. When you regenerate your Org-based (or Hugo,
using ox-hugo) website, the function `org-webring-generate-webring`
will be evaluated and the result will be displayed.


## Resources

Source code at [~brettgilio/org-webring](https://git.sr.ht/~brettgilio/org-webring).
[Send patches](https://git-send-email.io) and questions to [~brettgilio/org-webring@lists.sr.ht](https://lists.sr.ht/~brettgilio/org-webring).
Issue tracker here: [~brettgilio/org-webring](https://todo.sr.ht/~brettgilio/org-webring).


## License

Org-webring is licensed under the GNU General Public License,
version 3. See the [LICENSE](./LICENSE) file for the details.
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..6238dd9
--- /dev/null
+++ b/README.org
@@ -0,0 +1,35 @@
#+title: org-webring
#+options: toc:nil
* org-webring
  Generate webrings for Org-based sites blogs.

  Org-webring is an alternative implementation of a feed-based
  webring, taking inspiration from [[https://git.sr.ht/~sircmpwn/openring][openring]] by Drew DeVault. Intended
  to integrate with Org-based websites and blogs (either directly, or
  indirectly, as in ox-hugo), it will fetch a given list of web feed
  files and correctly parse and format the elements to be displayed
  for sharing.
** Usage
  The CSS file =org-webring.css= needs to be loaded by your website,
  and your browser must be able to render flex boxes.

  The file =ring.org= is a template. Copy it into a specified
  directory from where your website is generated. Add all relevant web
  feed URLs to ~org-webring-urls~ for fetching.

  To include the results of =ring.org= into an Org file export of your
  choosing, simply add: ~#+INCLUDE: ./ring.org~, taking care to modify
  the path appropriately. When you regenerate your Org-based (or Hugo,
  using ox-hugo) website, the function ~org-webring-generate-webring~
  will be evaluated and the result will be displayed.
** Resources
   Source code at [[https://git.sr.ht/~brettgilio/org-webring][~brettgilio/org-webring]].
   [[https://git-send-email.io][Send patches]] and questions to [[https://lists.sr.ht/~brettgilio/org-webring][~brettgilio/org-webring@lists.sr.ht]].
   Issue tracker here: [[https://todo.sr.ht/~brettgilio/org-webring][~brettgilio/org-webring]].
** License
   Org-webring is licensed under the GNU General Public License,
   version 3. See the [[./LICENSE][LICENSE]] file for the details.
* COMMENT Local variables
# Local Variables:
# eval: (add-hook 'after-save-hook #'org-md-export-to-markdown nil t)
# End:
-- 
2.28.0
Pushed with small tweaks in e90a769172a37baac20ecec8870ac2f7d639bfab.

Thank you!