Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 1.6 KB

README.md

File metadata and controls

49 lines (35 loc) · 1.6 KB
Raw

Trunk is a tool for learning new languages. It is inspired by Learning With Texts.

View more screenshots here.

⚠️ Trunk is currently under development and is not recommended for personal use. With that said, it currently works as so:

  1. Download the latest release for your platform.
  2. Find and create an article to practice reading.
  3. Read the article while marking the familiarity of words and adding translations.

Development

Requirements:

  • Node JS 14+ + Yarn.
  • Java runtime (for clojurescript compilation)

Emacs

  1. Clone repo.
  2. run yarn install
  3. Open a clojurescript file (such as main/core.cljs)
  4. Run m-x cider-jack-in-clojurescript
  5. Follow the prompts to run a shadow repl (and node-repl).
  6. Open your build running on http://localhost:9630/dashboard
  7. Navigate to "Builds"
  8. Press Watch button for main and renderer builds.
  9. Run yarn dev-electron in a new terminal.

In Terminal

  1. Clone repo.
  2. yarn install
  3. In one terminal run yarn dev-cljs
  4. Open your build running on http://localhost:9630/dashboard
  5. Navigate to "Builds"
  6. Press Watch button for main and renderer builds.
  7. In another terminal, run yarn dev-electron

Note: from time to time you will likely need to restart the yarn dev-electron process if you make stateful changes to certain variables that are only defined once, at boot.

Contributing