diff options
author | Beat Hagenlocher | 2024-06-27 18:27:34 +0200 |
---|---|---|
committer | Beat Hagenlocher | 2024-06-27 18:27:34 +0200 |
commit | 32fb46b63b549855668e54a57a6ace0372b6b18c (patch) | |
tree | 5b3025fae7851d170dd4533289245528a4202196 | |
parent | cd7cf527613ce220dc39bd705da72199b35fa0a1 (diff) |
Add README
-rw-r--r-- | README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc60702 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Functional Coders Tübingen + +The main website of the functional coders meetup Tübingen. +Written in [Racket](https://racket-lang.org) and [Pollen](https://pollenpub.com), built with [Nix](https://nixos.org), hosted on GitHub Pages. + +# Setup + + +## 1) Nix +The easiest way to get started with local development is to [use Nix](https://zero-to-nix.com/start/install): + +1. Install Nix +```bash +curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install +``` +2. Fork this repo +3. Enter the nix development environment (from inside the repo): +```bash +cd functional-coders.github.io && nix develop +``` +4. Run the project server +```bash +raco pollen start +``` +5. edit files, reload the browser window, see the changes + +## 2) 'Normal' install +1. Download & Install [Racket](https://racket-lang.org): [download.racket-lang.org](https://download.racket-lang.org) +2. Install [Pollen](https://pollenpub.com): +``` +λ raco pkg install --auto --skip-installed pollen racket-langserver string-interpolation +``` +3. Fork this repo. +4. Start Pollens' project server from the project root: +``` +λ raco pollen start +``` +5. edit some file; reload your browser window; see the change. |