Skip to content

Commit

Permalink
added dev info, rename to README
Browse files Browse the repository at this point in the history
  • Loading branch information
CiceroIsBack authored Nov 22, 2023
1 parent 1d0d050 commit a8ddc52
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions readme.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,22 @@ Loam is a fork of the excellent [Foam](https://github.com/foambubble/foam) VS Co

To see the features of Foam, check out [their README](https://github.com/foambubble/foam/blob/master/readme.md).

### Dev Info
Development is happening on the `dev` branch. The `master` branch is reserved for stable & tested releases.

To start developing, clone the repo, then run `yarn`. In VS Code, hit `F5` to start debug mode. A new VS Code window with the extension installed should open itself up automatically.
### Info

To enable automatic outlining and indenting, use the `Markdown All in One` extension.

Why "Loam"? Loam is a combination of "Logseq" + "Foam". Also, loam in the real world is rich soul that is good for growing plants. My hope is that Loam will be a good foundation for your knowledge garden, and help you grow your thoughts.
Why the name "Loam"? Loam is a combination of "Logseq" + "Foam". Also, loam in the real world is rich soul that is good for growing plants. My hope is that Loam will be a good foundation for your knowledge garden, and help you grow your thoughts.

### Features to Implement

- [ ] support hierarchy in links (namespaces; has to change "/" to "\_\_")
- [ ] support for tags as links (incl in backlinks section)
- [ ] support for block ids
- [ ] support collapsed::true ?? (not important)
- [ ] support collapsed::true ??
- [ ] support TODO / DONE
- [ ] fix page embeds (just make it use Logseq formatting; the functionality is already there)
- [ ] also support block embeds?

0 comments on commit a8ddc52

Please sign in to comment.