From 012c192aed77154a0a91a2c8c28c2440d92598b6 Mon Sep 17 00:00:00 2001 From: Tom Alexander Date: Fri, 11 Aug 2023 00:00:49 -0400 Subject: [PATCH] Bump version to 0.1.2 and change README to markdown. crates.io does not support org-mode for README files so I am changing this to markdown. --- Cargo.toml | 4 ++-- README.md | 13 +++++++++++++ README.org | 10 ---------- 3 files changed, 15 insertions(+), 12 deletions(-) create mode 100644 README.md delete mode 100644 README.org diff --git a/Cargo.toml b/Cargo.toml index df7e1d25..e969cd04 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,12 +1,12 @@ [package] name = "organic" -version = "0.1.1" +version = "0.1.2" authors = ["Tom Alexander "] description = "An org-mode parser." edition = "2021" license = "0BSD" repository = "https://code.fizz.buzz/talexander/organic" -readme = "README.org" +readme = "README.md" keywords = ["emacs", "org-mode"] categories = ["parsing"] resolver = "2" diff --git a/README.md b/README.md new file mode 100644 index 00000000..f45c108e --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Organic - Free Range Org-Mode + +Organic is an emacs-less implementation of an [org-mode](https://orgmode.org/) parser. + + +## Project Status + +This project is a personal learning project to grow my experience in [rust](https://www.rust-lang.org/). It is under development and at this time I would not recommend anyone use this code. The goal is to turn this into a project others can use, at which point more information will appear in this README. + + +## License + +This project is released under the public-domain-equivalent [0BSD license](https://www.tldrlegal.com/license/bsd-0-clause-license). This license puts no restrictions on the use of this code (you do not even have to include the copyright notice or license text when using it). HOWEVER, this project has a couple permissively licensed dependencies which do require their copyright notices and/or license texts to be included. I am not a lawyer and this is not legal advice but it is my layperson's understanding that if you distribute a binary with this library linked in, you will need to abide by their terms since their code will also be linked in your binary. I try to keep the dependencies to a minimum and the most restrictive dependency I will ever include is a permissively licensed one. diff --git a/README.org b/README.org deleted file mode 100644 index b687e08a..00000000 --- a/README.org +++ /dev/null @@ -1,10 +0,0 @@ -#+options: toc:nil -#+title: Organic - Free Range Org-Mode - -Organic is an emacs-less implementation of an [[https://orgmode.org/][org-mode]] parser. - -* Project Status -This project is a personal learning project to grow my experience in [[https://www.rust-lang.org/][rust]]. It is under development and at this time I would not recommend anyone use this code. The goal is to turn this into a project others can use, at which point more information will appear in this README. - -* License -This project is released under the public-domain-equivalent [[https://www.tldrlegal.com/license/bsd-0-clause-license][0BSD license]]. This license puts no restrictions on the use of this code (you do not even have to include the copyright notice or license text when using it). HOWEVER, this project has a couple permissively licensed dependencies which do require their copyright notices and/or license texts to be included. I am not a lawyer and this is not legal advice but it is my layperson's understanding that if you distribute a binary with this library linked in, you will need to abide by their terms since their code will also be linked in your binary. I try to keep the dependencies to a minimum and the most restrictive dependency I will ever include is a permissively licensed one.