Skip to content

Commit ca9b294

Browse files
committed
fix readme
1 parent de33a78 commit ca9b294

File tree

3 files changed

+32
-62
lines changed

3 files changed

+32
-62
lines changed

README.md

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,30 @@
11
[![CI](https://github.com/epics-containers/epic-containers.github.io/actions/workflows/ci.yml/badge.svg)](https://github.com/epics-containers/epic-containers-github-io/actions/workflows/ci.yml)
22
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
33

4-
# epics-containers
54

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.
77

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+
-----------
1010

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)
1613

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+
------------
2016

21-
```python
22-
from epics-containers import __version__
17+
Please contribute with comments and suggestions in the wiki or issues pages:
2318

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
2626

27-
Or if it is a commandline tool then you might put some example commands here:
2827

29-
```
30-
python -m epics-containers --version
31-
```
3228

3329
<!-- README only content. Anything below this line won't be included in index.md -->
3430

35-
See https://epics-containers.github.io/epic-containers.github.io for more detailed documentation.

README.rst

Lines changed: 0 additions & 41 deletions
This file was deleted.

docs/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,22 @@ html_theme.sidebar_secondary.remove: true
55
```{include} ../README.md
66
:end-before: <!-- README only content
77
```
8+
Communication
9+
-------------
10+
11+
If you are interested in discussing containers for control systems, please:
12+
13+
Add a brief description of your project and the status of it's use of containers to:
14+
- https://github.com/epics-containers/epics-containers.github.io/wiki/Brief-Overview-of-Projects-Using-Containers-in-Controls
15+
16+
Join in the discussion at:
17+
- https://github.com/epics-containers/epics-containers.github.io/discussions
18+
19+
Materials
20+
---------
21+
- [Oxfordshire EPICS Meeting Nov 2023](https://dlsltd-my.sharepoint.com/:p:/g/personal/giles_knap_diamond_ac_uk/Ee7SPC_39blEu4Pilgqul7IBiCi4GM9_cgMzONV2ALHIsw?e=U02gHd)
22+
- [ICALEPCS 2021 Paper: Kubernetes for EPICS IOCs](user/images/THBL04.PDF)
23+
- [ICALEPCS 2021 Talk: Kubernetes for EPICS IOCs](user/images/THBL04_talk.PDF)
824

925

1026
How the documentation is structured

0 commit comments

Comments
 (0)