Skip to content

Commit f81b424

Browse files
committed
#readme: polished
1 parent 12ddf6f commit f81b424

File tree

1 file changed

+43
-38
lines changed

1 file changed

+43
-38
lines changed

README.md

Lines changed: 43 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Try-phi
2-
31
<img alt="logo" src="https://www.objectionary.com/cactus.svg" height="100px" />
42

53
[![Hits-of-Code](https://hitsofcode.com/github/objectionary/try-phi?branch=main)](https://hitsofcode.com/view/github/objectionary/try-phi?branch=main)
@@ -10,9 +8,7 @@ Right now we implement it as a term rewriting system.
108

119
It is combined with [EO](https://github.com/objectionary/eo) editor. EO is based on 𝜑-calculus.
1210

13-
## Usage
14-
15-
- The online playground is available [here](https://www.objectionary.com/try-phi/?editor=phi&snippet=%5B%0A%20%20a%20-%3E%203%2C%0A%20%20b%20-%3E%20%5E0.a%0A%5D.b)
11+
The online playground is available [here](https://www.objectionary.com/try-phi/?editor=phi&snippet=%5B%0A%20%20a%20-%3E%203%2C%0A%20%20b%20-%3E%20%5E0.a%0A%5D.b)
1612

1713
## Components
1814

@@ -21,44 +17,53 @@ It is combined with [EO](https://github.com/objectionary/eo) editor. EO is based
2117
- [EO editor](https://github.com/br4ch1st0chr0n3/eo-editor)
2218
- [Phi editor](https://github.com/br4ch1st0chr0n3/phi-editor)
2319

24-
## Development
20+
## How to Contribute
21+
22+
Install [Nix](https://nixos.org/download.html) (Single-user installation)
23+
24+
```sh
25+
sh <(curl -L https://nixos.org/nix/install) --no-daemon
26+
```
2527

26-
- Install [Nix](https://nixos.org/download.html) (Single-user installation)
27-
```sh
28-
sh <(curl -L https://nixos.org/nix/install) --no-daemon
29-
```
28+
Install [direnv](https://nix.dev/tutorials/declarative-and-reproducible-developer-environments#direnv-automatically-activating-the-environment-on-directory-change) - steps 1, 2
3029

31-
- Install [direnv](https://nix.dev/tutorials/declarative-and-reproducible-developer-environments#direnv-automatically-activating-the-environment-on-directory-change) - steps 1, 2
30+
For [VS Code](https://code.visualstudio.com/)
3231

33-
- For [VS Code](https://code.visualstudio.com/)
3432
- Install extensions
35-
```sh
36-
code --install-extension mkhl.direnv --install-extension haskell.haskell --install-extension nwolverson.ide-purescript
37-
```
33+
34+
```sh
35+
code --install-extension mkhl.direnv --install-extension haskell.haskell --install-extension nwolverson.ide-purescript
36+
```
37+
3838
- Open workspace in `.vscode/try-phi.code-workspace`
3939

40-
- In separate terminals:
40+
Then, in separate terminals:
41+
4142
- backend dev
42-
```sh
43-
cd back
44-
# for the first time
45-
direnv allow
46-
# build for HLS
47-
nix build
48-
# start the server
49-
nix run
50-
```
43+
44+
```sh
45+
cd back
46+
# for the first time
47+
direnv allow
48+
# build for HLS
49+
nix build
50+
# start the server
51+
nix run
52+
```
53+
5154
- front
52-
```sh
53-
cd front
54-
# for the first time
55-
direnv allow
56-
# open app in a browser
57-
npm run dev
58-
# or any other commands from package.json
59-
```
60-
61-
- If in VS Code, reload the window (`Ctrl`+`Shift`+`P` -> `Developer: Reload window`) and repeat previous commands to start the server and the client
62-
63-
- For Haskell, your shell will have [haskell-language-server](https://github.com/haskell/haskell-language-server)
64-
- For Purescript - [purescript-language-server](https://github.com/nwolverson/purescript-language-server)
55+
56+
```sh
57+
cd front
58+
# for the first time
59+
direnv allow
60+
# open app in a browser
61+
npm run dev
62+
# or any other commands from package.json
63+
```
64+
65+
If in VS Code, reload the window (`Ctrl`+`Shift`+`P` -> `Developer: Reload window`) and repeat previous commands to start the server and the client
66+
67+
For Haskell, your shell will have [haskell-language-server](https://github.com/haskell/haskell-language-server)
68+
69+
For Purescript - [purescript-language-server](https://github.com/nwolverson/purescript-language-server)

0 commit comments

Comments
 (0)