From 5eb1a87123e9232a38dfdec22372e1fd240b4553 Mon Sep 17 00:00:00 2001 From: Jethro Kuan Date: Sat, 15 Feb 2020 15:30:33 +0800 Subject: [PATCH] Org-roam 0.1.1 (#83) * Update README * Add CONTRIBUTING * Add CHANGELOG --- CHANGELOG.md | 37 ++++++++++++++++++++++++++++ CONTRIBUTING.md | 34 ++++++++++++++++++++++++++ README.md | 64 +++++++++++++++++++++++++++++++++++++------------ 3 files changed, 120 insertions(+), 15 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..c04d99c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,37 @@ +# Changelog + +## 0.1.1 (2020-02-15) + +Mostly a documentation/cleanup release. + +### New Features +* [#62][gh-62] Add the options `org-roam-use-timestamps-as-filename` and `org-roam-file-format`, more in documentation. + +### Breaking Changes +* [#62][gh-62] The ID (file-name) workflow is no longer first-class, but a fallback when titles don't exist. + +### Changes +* [#66][gh-66], [#68][gh-68]: Improved the quality of the package in preparation of submission to MELPA +* [#73][gh-73]: Added CI to the project via Github Issues (Thanks [@alphapapa](https://github.com/alphapapa/) for scripts and setup) +* [#69][gh-69], [#72][gh-72], [#75][gh-75]: Major cleanup and de-duplication of code + +### Bugfixes +* [#67][gh-67]: Fixed `org-roam--make-file` not creating files with extensions +* [#71][gh-71], [#78][gh-78]: Fixed `org-roam-insert` not inserting correct paths +* [#82][gh-82]: Fixed nested Org-roam files not being detected as part of Org-roam + +[gh-62]: https://github.com/jethrokuan/org-roam/pull/66 +[gh-66]: https://github.com/jethrokuan/org-roam/pull/66 +[gh-67]: https://github.com/jethrokuan/org-roam/pull/67 +[gh-68]: https://github.com/jethrokuan/org-roam/pull/68 +[gh-69]: https://github.com/jethrokuan/org-roam/pull/69 +[gh-71]: https://github.com/jethrokuan/org-roam/pull/71 +[gh-72]: https://github.com/jethrokuan/org-roam/pull/72 +[gh-73]: https://github.com/jethrokuan/org-roam/pull/73 +[gh-75]: https://github.com/jethrokuan/org-roam/pull/75 +[gh-78]: https://github.com/jethrokuan/org-roam/pull/78 +[gh-82]: https://github.com/jethrokuan/org-roam/pull/82 + + # Local Variables: + # eval: (auto-fill-mode -1) + # End: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..27abf1a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# Contributing + +If you discover issues, have ideas for improvements or new features, please +report them to the [issue tracker][1] of the repository or submit a pull +request. Please, try to follow these guidelines when you do so. + +## Issue reporting + +* Check that the issue has not already been reported. +* Check that the issue has not already been fixed in the latest code + (a.k.a. `develop`). +* Be clear, concise and precise in your description of the problem. +* Open an issue with a descriptive title and a summary in grammatically correct, + complete sentences. +* Include any relevant code to the issue summary. +* If you're reporting performance issues it'd be nice if you added some profiling data (Emacs has a built-in profiler). + +## Pull requests + +* Read [how to properly contribute to open source projects on Github][2]. +* Use a topic branch to easily amend a pull request later, if necessary. +* Write [good commit messages][3]. +* Mention related tickets in the commit messages (e.g. `[Fix #N] Add missing autoload cookies`) +* Update the [changelog][5]. +* Use the same coding conventions as the rest of the project. +* Verify your Emacs Lisp code with `checkdoc` (C-c ? d). +* Open a [pull request][4] that relates to *only* one subject with a clear title + and description in grammatically correct, complete sentences. + +[1]: https://github.com/jethrokuan/org-roam/issues +[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request +[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +[4]: https://help.github.com/articles/using-pull-requests +[5]: https://github.com/jethrokuan/org-roam/blob/master/CHANGELOG.md diff --git a/README.md b/README.md index 7789b4c..af163b6 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,26 @@ +[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt) [![Documentation Status](https://readthedocs.org/projects/org-roam/badge/?version=latest)](https://org-roam.readthedocs.io/en/latest/?badge=latest) +[![GitHub Release](https://img.shields.io/github/v/release/jethrokuan/org-roam)](https://img.shields.io/github/v/release/jethrokuan/org-roam) + +## Synopsis Org-roam is a rudimentary [Roam][roamresearch] replica built around the all-powerful [Org-mode][org]. Like Roam, Org-roam offers a powerful and effortless non-hierarchical note-taking approach. With Org-roam, notes flow naturally, making -note-taking fun and easy. +note-taking fun and easy. Org-roam *enables* a note-taking workflow that +is not fluid with vanilla Org-mode (more in [this blog +post](https://blog.jethro.dev/posts/how_to_take_smart_notes_org/)). + The goal of the project is to implement core features of Roam around Org-mode, and eventually introduce features enabled by the Emacs -ecosystem. +ecosystem. -For more documentation, see [the documentation page](https://org-roam.readthedocs.io/en/latest/). - -## Understanding Roam - -To understand more about Roam, I recommend the following links: - -- [Building a second brain in - Roam](https://reddit.com/r/RoamResearch/comments/eho7de/building_a_second_brain_in_roamand_why_you_might) -- [Roam: Why I Love It and How I Use - It](https://www.nateliason.com/blog/roam) - -## Project Status +Visit [the documentation +page](https://org-roam.readthedocs.io/en/latest/) for a tutorial and +more links. As of February 2020, it is in a very early stage of development. @@ -37,16 +35,52 @@ used to navigate to the respective files. ![img](doc/images/org-roam-graph.gif) +## Installation + +The recommended method is using use-package and straight, or a similar package manager. + +```emacs-lisp +(use-package org-roam + :after org + :hook + ((org-mode . org-roam-mode) + (after-init . org-roam--build-cache-async) ;; optional! + ) + :straight (:host github :repo "jethrokuan/org-roam" :branch "develop") + :custom + (org-roam-directory "/path/to/org-files/") + :bind + ("C-c n l" . org-roam) + ("C-c n t" . org-roam-today) + ("C-c n f" . org-roam-find-file) + ("C-c n i" . org-roam-insert) + ("C-c n g" . org-roam-show-graph)) +``` + +For more detailed installation instructions, please see [the +installation +documentation](https://org-roam.readthedocs.io/en/develop/installation/). + ## Knowledge Bases using Org-Roam - [Jethro Kuan](https://braindump.jethro.dev/) ([Source](https://github.com/jethrokuan/braindump/tree/master/org)) +## Changelog + +A changelog is being maintained [here](CHANGELOG.md) + ## Contributing To report bugs and suggest new feature use the issue tracker. If you have some code which you would like to be merged, then open a pull -request. Please also see CONTRIBUTING.md. +request. Please also see [CONTRIBUTING.md](CONTRIBUTING.md). + +## License + +Copyright © Jethro Kuan and contributors. Distributed under the GNU +General Public License, Version 3 [roamresearch]: https://www.roamresearch.com/ [org]: https://orgmode.org/ +[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg