https://github.com/LilaRest/flowcus

A web companion that provides a clutter-free reader, web clippers, an highlighter and much more tools compatible with KM softwares (such as Obsidian, Roam Research, Foam, etc.)
https://github.com/LilaRest/flowcus

clipper clutter-free flow foam focus frictionless highlighter markdown minimalism obsidian-md productivity reader roam-research web-clipper

Last synced: 3 months ago
JSON representation

A web companion that provides a clutter-free reader, web clippers, an highlighter and much more tools compatible with KM softwares (such as Obsidian, Roam Research, Foam, etc.)

• Host: GitHub
• URL: https://github.com/LilaRest/flowcus
• Owner: LilaRest
• License: other
• Created: 2022-01-03T08:56:23.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T12:40:14.000Z (almost 2 years ago)
• Last Synced: 2024-07-28T21:56:59.976Z (3 months ago)
• Topics: clipper, clutter-free, flow, foam, focus, frictionless, highlighter, markdown, minimalism, obsidian-md, productivity, reader, roam-research, web-clipper
• Language: JavaScript
• Homepage:
• Size: 776 KB
• Stars: 11
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-foam - Flowcus - on for clutter-free reading and clipping, highlighting, conversions, etc. ('External' Tools / Other)

README

        
# _**"Flowcus"**_ add-on for Firefox, Chrome and Opera

![](https://github.com/LilaRest/Flowcus/raw/master/0_common/staticfiles/images/logo-dark.png)

Flowcus (flowing focus) is an highly customizable clutter-free reader that comes with many tools to interact with your favorite KM (Knowledge Management) software : a web clipper, an highlighter, a markdown converter, and much more !

Currently these KM softwares are supported :

- Obsidian

- Roam Research

- Foam

## Support my work

If you like using this browser's add-on, you can :

- TODO

## How to install ?

TODO

## What you can customize ?

TODO

## How to contribute ?

### Contribute by _**testing**_ the add-on

1) Test the add-on features

2) Observe a bug or an improvement that could be made

3) Report it by [creating an issue](https://github.com/LilaRest/Flowcus/issues/new)

### Contribute by _**coding**_ the add-on

- If you have found a bug or a potential improvement for the add-on and want to code it, we would be happy to accept your PRs!

  **Important :** It'd be good to talk about it beforehand to make sure that no one else is working on it. You can [open an issue](https://github.com/LilaRest/Flowcus/issues/new) for this.

- If you want to code but don't know where to start :

  1) Check out the issues labelled "[help wanted](https://github.com/LilaRest/Flowcus/labels/help%20wanted)".

  2) Check out [our roadmap](https://github.com/LilaRest/Flowcus/projects/1) and choose an unassigned task

**Here are the steps to contribute to the Flowcus' code :**

1) Fork this repository

2) Clone your fork on your computer using `git clone https://github.com//Flowcus.git`

3) In local, navigate into the cloned folder called `Flowcus/`

4) Add the Flowcus project repository as the "upstream" remote using `git remote add upstream https://github.com/LilaRest/Flowcus.git`

5) Now you can easily pull the new updates on the Flowcus repository using `git pull upstream master`

5) Apply changes in your local repository

6) Commit your changes using `git add -A` + `git commit -m ""`

7) Push your changes to your fork repository using `git push origin master`

8) Return to your fork on Github, refresh the page and you should see an highlighted area that invites you to initiate a Pull Request. (alternatively you can click on the "New pull request" button)