Skip to content

Commit

Permalink
Merge pull request #25 from epics-extensions/tops-not-apps
Browse files Browse the repository at this point in the history
Tops, not apps, and StreamDevice tutorial
  • Loading branch information
minijackson authored Jan 11, 2024
2 parents f2b354f + 7be1fea commit 3ba438d
Show file tree
Hide file tree
Showing 13 changed files with 714 additions and 295 deletions.
3 changes: 2 additions & 1 deletion doc/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ website:
- section: User Tutorials
file: ./ioc/tutorials.md
contents:
- ./ioc/tutorials/getting-started.md
- ./ioc/tutorials/pre-requisites.md
- ./ioc/tutorials/streamdevice.md
- ./ioc/tutorials/porting.md
- ./ioc/tutorials/day-to-day-dev.md
- ./ioc/tutorials/integration-tests.md
Expand Down
1 change: 1 addition & 0 deletions doc/_vale/Vocab/EPNix/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ NixOS
NixOps
procServ
SELinux
StreamDevice
systemd
RedHat
[Uu]ntracked
23 changes: 12 additions & 11 deletions doc/ioc/guides/flake-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,17 @@
title: Setting up the flake registry
---

Since the usage of EPNix doesn't encourage installing epics-base globally, some commonly used command-line programs won't be available in your usual environment.
While developing with EPNix,
it's possible you will end up typing `'github:epics-extensions/epnix'` quite often.

It's possible to go into a top, and type `nix develop`{.bash} just to have the `caget`{.bash} command available, but it's quite tedious.
It happens when you need to create a "top" template,
or when you just want to have `epics-base` in your shell,
and so on.

An alternative would be to run:
This is tedious.

``` bash
nix develop 'github:epics-extensions/epnix'
```

This will give you the development shell of EPNix itself, with the added benefit of having the latest version of EPICS base.

The command is quite hard to remember, but with the "registry" feature of Nix, you can shorten it by running:
Nix provides a way of shortening these URLs,
by adding to the [Nix registry][]:

``` bash
nix registry add epnix 'github:epics-extensions/epnix'
Expand All @@ -27,8 +25,11 @@ For example, the develop command to have EPICS based installed outside of a top
nix develop epnix
```

Another benefit is that you can now initialize an EPNix top by running:
If you want to initialize an EPNix top,
you can run:

``` bash
nix flake new -t epnix my-top
```

[Nix registry]: https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-registry.html#description
273 changes: 0 additions & 273 deletions doc/ioc/tutorials/getting-started.md

This file was deleted.

Loading

0 comments on commit 3ba438d

Please sign in to comment.