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
If you like using this browser's add-on, you can :
- TODO
TODO
TODO
- Test the add-on features
- Observe a bug or an improvement that could be made
- Report it by creating an issue
- 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 :
- Check out the issues labelled "help wanted".
- Check out our roadmap and choose an unassigned task
Here are the steps to contribute to the Flowcus' code :
- Fork this repository
- Clone your fork on your computer using
git clone https://github.com/<YourGithubName>/Flowcus.git - In local, navigate into the cloned folder called
Flowcus/ - Add the Flowcus project repository as the "upstream" remote using
git remote add upstream https://github.com/LilaRest/Flowcus.git - Now you can easily pull the new updates on the Flowcus repository using
git pull upstream master - Apply changes in your local repository
- Commit your changes using
git add -A+git commit -m "<YourChangesDescription>" - Push your changes to your fork repository using
git push origin master - 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)