Skip to content

Commit 48179c9

Browse files
readme changes (#39)
* Update README.md * Update README.md
1 parent a7d9b59 commit 48179c9

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,18 @@ Next-Generation scientific mind mapping.
1212

1313
You can find a list of shortcuts at [shortcuts.md](shortcuts.md).
1414

15+
1516
## 🌟 Try It Out!
1617

17-
There are a couple of ways to try out JabMap. The fastest way to just get a grasp of it is on [github pages](https://jabref.github.io/jabmap/). Note that this will merely allow you to create some nodes, edit and tag them. Saving, Loading and JabRef-related features like BibTeX-Nodes and importing attached PDF-files as nodes won't work unless you are running our version of JabRef's HTTP-Server (see [below](##-🤖-getting-the-server-running) for setup) since the mentioned features rely on it.
18+
There are a couple of ways to try out JabMap. In any case, you first have to start the HTTP-Server on your machine since Saving, Loading and JabRef-related features like BibTeX-Nodes and importing attached PDF-files as nodes won't work unless you are running JabRef's HTTP-Server (see [below](#-getting-the-server-running) for setup). Afterwards check out [github pages](https://jabref.github.io/jabmap/) where you can try JabMap in your browser!
19+
20+
> Note: It's still possible your browser blocks access to the server due to HTTP/HTTPS issues
21+
> If you see an Error 404 page, this is most likely the cause. Check if the server has started properly or use another browser and try again.
22+
>
23+
> For the best experience follow the steps below on how to try JabMap.
1824
19-
>Note: It's still possible your browser blocks access to the server due to HTTP/HTTPS issues, for the best experience follow the steps below on how to try JabMap running it locally.
2025

21-
### Running it locally
26+
### Quick-Start-Guide
2227

2328
The following commands get the code in place and start JabRef and JabMap with the help of a handy wrapper tool called [gg.cmd](https://github.com/eirikb/gg).
2429
A little terminal magic is required, but don't worry, we have the commands all laid out for you!
@@ -28,14 +33,18 @@ A little terminal magic is required, but don't worry, we have the commands all l
2833
1. Go to your git-repositories folder and start a new terminal session
2934
2. `git clone --recurse-submodules https://github.com/JabRef/jabref.git`
3035
3. `cd jabref`
31-
4. `git checkout jabmap`
32-
5. Enable nice wrapper: `curl -L ggcmd.io > gg.cmd`
33-
6. `sh ./gg.cmd just run-pr 13519`
34-
7. Wait for JabRef to come up
35-
8. File > Preferences > Check "HTTP Server"
36+
4. Enable nice wrapper: `curl -L ggcmd.io > gg.cmd`
37+
5. `sh ./gg.cmd just run-pr 13519`
38+
6. Wait for JabRef to come up
39+
7. Click on "Create example Library"
40+
8. Save (Button in the top left or <kbd>CTRL/CMD</kbd> + <kbd>S</kbd>)
41+
9. File > Preferences > Check "HTTP Server"
42+
3643

3744
#### JabMap:
3845

46+
After setting up JabRef, you can either use [JabMap on GitHub pages](https://jabref.github.io/jabmap/) or follow these steps to run it locally.
47+
3948
1. Go to your git-repositories folder and start a new terminal session
4049
2. Clone it: `git clone git@github.com:JabRef/jabmap.git`
4150
3. `cd jabmap`
@@ -44,7 +53,7 @@ A little terminal magic is required, but don't worry, we have the commands all l
4453
6. Install dependencies: `sh gg.cmd npm install`
4554
7. Build: `sh ./gg.cmd npm run build`
4655
8. Run: `sh ./gg.cmd npm run preview`
47-
9. Now one can open http://localhost:4173/ and open a library with the corresponding map.
56+
9. Now you can open http://localhost:4173/ and open a library with the corresponding map.
4857

4958

5059
## 🤖 Getting the server running
@@ -53,12 +62,15 @@ As mentioned above, several features are handled by JabRef's HTTP server. Curren
5362

5463
### using gg.cmd
5564

56-
If you followed the steps (**running-it-locally**) above, instead of steps 6. - 9. you can simply do the following to start the server without JabRef's GUI:
65+
If you followed the setup for JabRef [above](#jabref), instead of steps 6. - 9. you can simply do the following to start the server without JabRef's GUI:
5766

5867
```
5968
sh ./gg.cmd jbang .jbang/JabSrvLauncher.java
6069
```
6170

71+
> Note: this is **not** recommended for trying out JabMap for the first time since it will not allow you to create a new library. Use this only if you already used JabRef before :)
72+
73+
6274
### Starting it from an IDE
6375

6476
1. If you haven't already, clone our [JabRef's fork repository](https://github.com/iloveskittles82/jabref) (_Note: It is recommended to complete this step of_ [_JabRef's setup guide_](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.html)).

0 commit comments

Comments
 (0)