|
1 | 1 | [](https://github.com/epics-containers/epic-containers-github-io/actions/workflows/ci.yml)
|
2 | 2 | [](https://opensource.org/licenses/Apache-2.0)
|
3 | 3 |
|
4 |
| -# epics-containers |
5 | 4 |
|
6 |
| -Documentation for the epics-containers framework |
| 5 | +The epics-containers GitHub organization holds a collection of tools and |
| 6 | +documentation for building, deploying and managing containerized EPICS IOCs. |
7 | 7 |
|
8 |
| -This is where you should write a short paragraph that describes what your module does, |
9 |
| -how it does it, and why people should use it. |
| 8 | +Quick Start |
| 9 | +----------- |
10 | 10 |
|
11 |
| -Source | <https://github.com/epics-containers/epic-containers.github.io> |
12 |
| -:---: | :---: |
13 |
| -PyPI | `pip install epic-containers` |
14 |
| -Documentation | <https://epics-containers.github.io/epic-containers.github.io> |
15 |
| -Releases | <https://github.com/epics-containers/epic-containers.github.io/releases> |
| 11 | +See [Essential Concepts](https://epics-containers.github.io/main/user/explanations/introduction.html) |
| 12 | +and the [Getting Started Guide](https://epics-containers.github.io/main/user/tutorials/intro.html) |
16 | 13 |
|
17 |
| -This is where you should put some images or code snippets that illustrate |
18 |
| -some relevant examples. If it is a library then you might put some |
19 |
| -introductory code here: |
| 14 | +Useful Links |
| 15 | +------------ |
20 | 16 |
|
21 |
| -```python |
22 |
| -from epics-containers import __version__ |
| 17 | +Please contribute with comments and suggestions in the wiki or issues pages: |
23 | 18 |
|
24 |
| -print(f"Hello epics-containers {__version__}") |
25 |
| -``` |
| 19 | +| Item | Link |
| 20 | +| -------------- | --------------------- |
| 21 | +| Documentation | https://epics-containers.github.io |
| 22 | +| Wiki | https://github.com/epics-containers/epics-containers.github.io/wiki |
| 23 | +| Issues | https://github.com/epics-containers/epics-containers.github.io/issues |
| 24 | +| Docs Source | https://github.com/epics-containers/epics-containers.github.io |
| 25 | +| Organization | https://github.com/epics-containers |
26 | 26 |
|
27 |
| -Or if it is a commandline tool then you might put some example commands here: |
28 | 27 |
|
29 |
| -``` |
30 |
| -python -m epics-containers --version |
31 |
| -``` |
32 | 28 |
|
33 | 29 | <!-- README only content. Anything below this line won't be included in index.md -->
|
34 | 30 |
|
35 |
| -See https://epics-containers.github.io/epic-containers.github.io for more detailed documentation. |
0 commit comments