Skip to content

Commit 7d0a621

Browse files
committed
edited readme
1 parent d239e75 commit 7d0a621

File tree

3 files changed

+15
-155
lines changed

3 files changed

+15
-155
lines changed

.github/workflows/fileformats-ci-cd.yaml

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

related-packages/fileformats-extras/README.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
1-
FileFormats-CHANGEME Extras
2-
======================================
1+
FileFormats-medimage-CHANGEME Extras
2+
====================================
3+
34
.. image:: https://github.com/nipype/pydra-freesurfer/actions/workflows/ci-cd.yaml/badge.svg
45
:target: https://github.com/nipype/pydra-freesurfer/actions/workflows/ci-cd.yaml
56

67

7-
This is a extras module for the `fileformats-CHANGEME <https://github.com/nipype/pydra-freesurfer/>`__
8+
This is a extras module for the `fileformats-medimage-CHANGEME <https://github.com/nipype/pydra-CHANGEME/>`__
89
fileformats extension package, which provides additional functionality to format classes (i.e. aside
9-
from basic identification and validation), such as conversion tools, metadata parsers, test data generators, etc...
10+
from basic identification and validation), such as conversion tools, metadata parsers,
11+
sample data generators, etc...
1012

1113

1214
Quick Installation
1315
------------------
1416

1517
This extension can be installed for Python 3 using *pip*::
1618

17-
$ pip3 install fileformats-CHANGEME-extras
19+
$ pip3 install fileformats-medimage-CHANGEME-extras
1820

19-
This will install the core package and any other dependencies
21+
This will install the package, base packages, and any other dependencies required to
22+
implement the extra functionality.
2023

2124
License
2225
-------

related-packages/fileformats/README.rst

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,21 @@
1-
How to customise this template
2-
==============================
1+
FileFormats-medimage-CHANGEME
2+
=============================
33

4-
#. Rename the `related-packages/fileformats/CHANGEME` directory to the name of the fileformats subpackage (e.g. `medimage_fsl`)
5-
#. Search and replace "CHANGEME" with the name of the fileformats subpackage the extras are to be added
6-
#. Replace name + email placeholders in `pyproject.toml` for developers and maintainers
7-
#. Add the extension file-format classes
8-
#. Ensure that all the extension file-format classes are imported into the extras package root, i.e. `fileformats/CHANGEME`
9-
#. Delete these instructions
10-
11-
...
12-
13-
FileFormats Extension - CHANGEME
14-
====================================
154
.. image:: https://github.com/nipype/pydra-CHANGEME/actions/workflows/ci-cd.yml/badge.svg
165
:target: https://github.com/nipype/pydra-CHANGEME/actions/workflows/ci-cd.yml
176

18-
This is the "CHANGEME" extension module for the
19-
`fileformats <https://github.com/ArcanaFramework/fileformats-core>`__ package
7+
This is an extension module of the `fileformats <https://github.com/ArcanaFramework/fileformats>`__
8+
package for defining file formats that are specific to the CHANGME software toolkit.
209

2110

2211
Quick Installation
2312
------------------
2413

2514
This extension can be installed for Python 3 using *pip*::
2615

27-
$ pip3 install fileformats-CHANGEME
16+
$ pip3 install fileformats-medimage-CHANGEME
2817

29-
This will install the core package and any other dependencies
18+
This will install the format extensions and dependent base packages.
3019

3120
License
3221
-------

0 commit comments

Comments
 (0)