Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
rwst committed Aug 30, 2023
1 parent 93bb331 commit 26ed62f
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 11 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ workspace.xml
*.iml
*.ipr
out/
output/
!**/src/main/**/out/
!**/src/test/**/out/

Expand Down
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,12 @@ JVM desktop app for systematic literature collection.

LitBall applies the literature snowballing algorithm[1] on an academic graph (AG) and facilitates the creation of a systematic literature collection on a specific topic. Search runs, starting with a small set of initial papers, are sequences of up- and down-sweeps within the AG, intertwined with filtering using different filters. LitBall saves the state of these processing steps in a local database and all retrieved graph data. Output can be visualized or exported as a database for import in any spreadsheet.

LitBall uses [Kotlin/Compose](https://www.jetbrains.com/lp/compose-mpp/). Users can only try the application in alpha versions by running it in IntelliJ IDEA. Later, we plan to use [Conveyor](https://www.hydraulic.software/index.html) to provide binaries for Linux/Windows/Mac.
LitBall uses [Kotlin/Compose](https://www.jetbrains.com/lp/compose-mpp/). Get it from https://rwst.github.io/Litball-download, there are binaries for Linux/Windows/Mac. Please give us feedback, especially on Win/Mac, as we only test on Linux.

## Quick Install
Since LitBall is still alpha (but usable), you need to install IntelliJ IDEA and, optionally, if you want to use AI filters, the YDF package.
Download link: https://rwst.github.io/Litball-download

For IntelliJ IDEA, please refer to https://www.jetbrains.com/idea/. The free version suffices.

After you install IntelliJ IDEA:
Start it and create a new project from version control.
Give this repository URL (https://github.com/rwst/LitBall).
Click Clone.
After some background indexing, start LitBall by clicking the triangle in the top toolbar, right of center.
Optionally, if you want to use AI filters, you need the YDF package, see https://github.com/google/yggdrasil-decision-forests

## LitBall Configuration
See Settings on the Main screen. The first path will be the directory that holds your current queries. Changing this will read and display all queries in that directory.
Expand Down
3 changes: 1 addition & 2 deletions conveyor.conf
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ include "#!./gradlew -q printConveyorConfig"
gradle.build-dir = /home/ralf/IdeaProjects/LitBall/build
gradle.project-name = LitBall
app.fsname = lit-ball
app.version = 2308
app.rdns-name = org.reactome.${app.fsname}
app.site.base-url = rwst.github.io/LitBall
app.site.base-url = rwst.github.io/LitBall-download
app.vcs-url = github.com/rwst/LitBall
app.license = "CC0 1.0 Universal"
app.jvm.gui.main-class = MainKt
Expand Down

0 comments on commit 26ed62f

Please sign in to comment.