Skip to content

Latest commit

 

History

History
43 lines (35 loc) · 2.3 KB

README.md

File metadata and controls

43 lines (35 loc) · 2.3 KB
Raw

"Flowcus" add-on for Firefox, Chrome and Opera

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

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 for this.
  • If you want to code but don't know where to start :
    1. Check out the issues labelled "help wanted".
    2. Check out our roadmap 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/<YourGithubName>/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
  6. Apply changes in your local repository
  7. Commit your changes using git add -A + git commit -m "<YourChangesDescription>"
  8. Push your changes to your fork repository using git push origin master
  9. 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)