upd readmes

Author: deemp

README.md

@@ -19,26 +19,18 @@ We implement it as a term rewriting system.
 - [EO editor](https://github.com/deemp/eo-editor)
 - [Phi editor](https://github.com/deemp/phi-editor)
 
-## Prerequisites
-
-- Install [Nix](https://nixos.org/download.html) (Single-user installation)
-
-  ```sh
-  sh <(curl -L https://nixos.org/nix/install) --no-daemon
-  ```
+## Quick start
 
-- Enable [flakes](https://nixos.wiki/wiki/flakes/8ee5d35e592860636adb57cee3e27c98de04202a#Permanent)
+1. [Install Nix](https://github.com/deemp/flakes/blob/main/README/InstallNix.md)
 
-- Enter the repo
+1. Enter the repo.
 
   ```sh
   git clone https://github.com/objectionary/try-phi
   cd try-phi
   ```
 
-## Quick start
-
-- Run back and front in separate terminals
+1. Run `back end` and `front end` in separate terminals.
 
   ```console
   nix run .#back
@@ -47,31 +39,25 @@ We implement it as a term rewriting system.
 
 ## Development
 
-- Install [direnv](https://nix.dev/tutorials/declarative-and-reproducible-developer-environments#direnv-automatically-activating-the-environment-on-directory-change) - steps 1, 2
-
-- [Enable flakes](https://nixos.wiki/wiki/flakes/8ee5d35e592860636adb57cee3e27c98de04202a#Enable_flakes)
-
-- Allow direnv in flake folders
+1. Allow `direnv` in flake folders.
 
   ```sh
   direnv allow
   (cd front && direnv allow)
   (cd back && direnv allow && stack build)
   ```
 
-- Open Codium
+1. Start a deshell.
 
   ```console
   nix develop
-  codium .
   ```
 
-- Hotkey for `Command palette` - `Ctrl` (`Cmd`) + `Shift` + `P`
+1. (Optionally) Start `VSCodium`.
 
-- Start app - a browser window should open
-  - Command palette -> `Tasks: Run Task` -> `Run app`
-
-- Terminate app
-  - Command palette -> `Tasks: Terminate Task` -> `All Running Tasks`>
+  ```console
+  nix run .#writeSettings
+  nix run .#codium .
+  ```
 
-- In case of problems reload the window (`Ctrl` + `Shift` + `P` -> `Developer: Reload window`) and repeat previous commands to start the server and the client
+1. In a `.hs` file, hover over a function. `HLS` should start giving the type info soon.

back/README.md

@@ -1,45 +1,47 @@
 # Try-phi backend
 
-## Dependencies
+## Quick start
 
-- Install [stack](https://docs.haskellstack.org/en/stable/README/)
+1. [Install Nix](https://github.com/deemp/flakes/blob/main/README/InstallNix.md)
 
-## Run
-
-* Build and execute
+1. Enter the dir.
 
   ```sh
-  sh run.sh
+  git clone https://github.com/objectionary/try-phi
+  cd try-phi/back
   ```
 
-## Deploy to Heroku
+1. Run `back end`.
+
+  ```console
+  nix run
+  ```
 
-- Read [this](https://hackernoon.com/for-all-the-world-to-see-deploying-haskell-with-heroku-7ea46f827ce) till `web: run-server`
+## Development
 
-- Select a port when running locally:
+1. Start a deshell.
+
+  ```console
+  nix develop
+  ```
 
-```haskell
-startApp :: IO ()
-startApp = catchIOError
-  (do
-    port <- read <$> getEnv "Port"
-    print port
-    run port app)
-  (\_ -> run 8082 app)
-```
+1. Build the package
 
-- Next, add a `Procfile` and [commit](https://devcenter.heroku.com/articles/procfile#deploying-to-heroku) it to `heroku`
+  ```console
+  cabal build
+  ```
+
+1. (Optionally) Start `VSCodium`.
+
+  ```console
+  nix run .#writeSettings
+  nix run .#codium .
+  ```
 
-- Return to the [guide](https://hackernoon.com/for-all-the-world-to-see-deploying-haskell-with-heroku-7ea46f827ce)
+1. In a `.hs` file, hover over a function. `HLS` should start giving the type info soon.
 
-- `push` and get
+1. [Troubleshoot](https://github.com/deemp/flakes/blob/main/README/Troubleshooting.md) if necessary
 
-```sh
-2022-06-25T14:39:52.239150+00:00 heroku[web.1]: State changed from crashed to starting
-2022-06-25T14:39:53.260912+00:00 heroku[web.1]: Starting process with command `try-servant-exe`
-2022-06-25T14:40:53.904920+00:00 heroku[web.1]: Error R10 (Boot timeout) -> Web process failed to bind to $PORT within 60 seconds of launch
-2022-06-25T14:40:53.936273+00:00 heroku[web.1]: Stopping process with SIGKILL
-2022-06-25T14:40:54.126423+00:00 heroku[web.1]: Process exited with status 137
-2022-06-25T14:40:54.215588+00:00 heroku[web.1]: State changed from starting to crashed
+## References
 
-```
+- Heroku's [Container Registry & Runtime (Docker Deploys)](https://devcenter.heroku.com/articles/container-registry-and-runtime#dockerfile-commands-and-runtime)

front/README.md

@@ -2,45 +2,51 @@
 
 This is a `PureScript` version of `try-phi` front end. Previously, it was written in [Elm](https://github.com/fizruk/try-phi/tree/cf29332d08376e1da90c851f5326b440ac070763) and [Haskell](https://github.com/fizruk/try-phi/commit/bc04b4d61b00f79ad7736769d1420d632e294579) (via `Miso`). It uses `Halogen` for UI.
 
-## Dependencies
+## Quick Start
 
-- Install [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm/)
+1. [Install Nix](https://github.com/deemp/flakes/blob/main/README/InstallNix.md)
 
-## Quick Start
+1. Switch to this directory
+
+    ```sh
+    git clone https://github.com/objectionary/try-phi
+    cd try-phi/front
+    ```
 
-- Switch to this directory, build and run the project
+1. Run project:
 
-```sh
-cd front
-npm run quick-start
-```
+    ```console
+    nix develop
+    npm run quick-start
+    ```
 
-- If there is an [inotify error](https://askubuntu.com/a/1088275), run
+   - If there is an [inotify error](https://askubuntu.com/a/1088275), run
 
-```sh
-echo fs.inotify.max_user_watches=1000000 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
-```
+   ```sh
+   echo fs.inotify.max_user_watches=1000000 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
+   ```
 
-Now, your browser will open, showing [http://localhost:1234](http://localhost:1234)
+1. Now, your browser will open, showing [http://localhost:1234](http://localhost:1234)
 
 ## Develop
 
-- Run
+1. Run
 
-```sh
-npm run dev
-```
+    ```sh
+    nix develop
+    npm run dev
+    ```
 
 If you're using an [editor](https://github.com/purescript/documentation/blob/master/ecosystem/Editor-and-tool-support.md#editors) that supports [`purs ide`](https://github.com/purescript/purescript/tree/master/psc-ide) or are running [`pscid`](https://github.com/kRITZCREEK/pscid), you simply need to keep the previous `npm run dev` command running in a terminal. Any save to a file **used** in the project will trigger an incremental recompilation, rebundle, and web page refresh, so you can immediately see your changes.
 
 If your workflow does not support automatic recompilation, then you will need to manually re-run `npm run build`. Even with automatic recompilation, a manual rebuild is occasionally required, such as when you add, remove, or modify module names, or notice any other unexpected behavior.
 
 ## Deployment
 
-* Produce the bundled and minified code at `./prod` and see the app running in a browser via [http-server](https://www.npmjs.com/package/http-server):
+1. Produce the bundled and minified code at `./prod` and see the app running in a browser via [http-server](https://www.npmjs.com/package/http-server):
 
-```sh
-npm run build:prod
-```
+    ```sh
+    npm run build:prod
+    ```
 
-* Now, you may deploy your app to a static hosting service, e.g., GitHub Pages (see this [post](https://javascript.plainenglish.io/deploying-any-app-to-github-pages-1e8e946bf890))
+1. Now, you may deploy your app to a static hosting service, e.g., GitHub Pages (see this [post](https://javascript.plainenglish.io/deploying-any-app-to-github-pages-1e8e946bf890))