Skip to content

Commit d316d28

Browse files
committed
Doc: fix dev instructions; add more screenshots.
1 parent 1d26b24 commit d316d28

File tree

10 files changed

+11
-4
lines changed

10 files changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
11
Trunk is an early prototype of a tool for learning new languages. It
22
is inspired by [Learning With Texts](https://learningwithtexts.com/).
33

4-
![](./docs/screenshots/trunk_1_phrase.png)
4+
![](./docs/screenshots/trunk_word.png)
5+
6+
View more screenshots [here](./docs/screenshots).
57

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

911
1. Download the [latest release](https://github.com/theiceshelf/trunk/releases) for your platform.
10-
2. Find and create an article to practice reading (preferrably something short!).
12+
2. Find and create an article to practice reading (preferrably something short).
1113
3. Read the article while marking the familiarity of works and adding translations.
1214

1315
### Development
1416

17+
Requirements:
18+
19+
- Node JS 14+ + Yarn.
20+
- Java runtime (for clojurescript compilation)
21+
1522
**Emacs**
1623

1724
1. Clone repo.
18-
1. run `npm install`
25+
1. run `yarn install`
1926
1. Open a clojurescript file (such as main/core.cljs)
2027
1. Run `m-x cider-jack-in-clojurescript`
2128
1. Follow the prompts to run a `shadow` repl (and `node-repl`).
@@ -28,7 +35,7 @@ With that said, it currently works as so:
2835

2936
1. Clone repo.
3037
1. `npm install`
31-
1. In one terminal run `npm dev-cljs`
38+
1. In one terminal run `npm run dev-cljs`
3239
1. Open your build running on `http://localhost:9630/dashboard`
3340
1. Navigate to "Builds"
3441
1. Press `Watch` button for `main` and `renderer` builds.

docs/design.afdesign

1.75 KB
Binary file not shown.
-1.94 MB
Binary file not shown.

docs/screenshots/trunk_2_word.png

-1.91 MB
Binary file not shown.

docs/screenshots/trunk_3_about.png

-2.31 MB
Binary file not shown.
-2.09 MB
Binary file not shown.

docs/screenshots/trunk_about.png

2.47 MB
Loading

docs/screenshots/trunk_phrase.png

1.88 MB
Loading

docs/screenshots/trunk_word.png

1.9 MB
Loading

docs/screenshots/trunk_words.png

1.55 MB
Loading

0 commit comments

Comments
 (0)