Skip to content

Commit

Permalink
rename
Browse files Browse the repository at this point in the history
  • Loading branch information
fmatter committed Nov 10, 2023
1 parent c161d1a commit 8d83ccc
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 8 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# FLEx script collection
This is a collection of scripts for SIL's [FieldWorks](https://software.sil.org/fieldworks/) projects.
Download a [ZIP](https://github.com/fmatter/flex-script-collection/archive/refs/heads/main.zip) from or clone the repository:
# Language documentation script collection
This is a collection of scripts for common language documentation workflows.
Download a [ZIP](https://github.com/fmatter/langdoc-script-collection/archive/refs/heads/main.zip) from or clone the repository:

```
git clone https://github.com/fmatter/flex-script-collection
git clone https://github.com/fmatter/langdoc-script-collection
```

See pages for individual scripts for usage instructions.
It is recommended to use a [virtual environment](https://docs.python.org/3/library/venv.html) to install necessary packages.

## Contribute a new script
To add a script to the collection, [fork the github repository](https://github.com/fmatter/flex-script-collection/fork), use a [virtual environment](https://docs.python.org/3/library/venv.html) to `pip install -r requirements.txt`, and add the following files to your fork:
To add a script to the collection, [fork the github repository](https://github.com/fmatter/langdoc-script-collection/fork), use a [virtual environment](https://docs.python.org/3/library/venv.html) to `pip install -r requirements.txt`, and add the following files to your fork:

1. a `my_script.py` (or other suffix) file, ideally with:
* name and contact info
Expand Down
4 changes: 4 additions & 0 deletions docs/scripts/dict_audio_path.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- flex
---
# Add prefix to audio path (`.lift`)
This script iterates a `.lift` export and modifies the `href` attribute of every `media` tag.
This is where paths to audio files are stored.
Expand Down
Empty file added docs/tags.md
Empty file.
11 changes: 9 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
site_name: FLEx script collection
repo_url: https://github.com/fmatter/flex-script-collection
site_name: Language documentation script collection
repo_url: https://github.com/fmatter/langdoc-script-collection
plugins:
- search
- tags:
tags_file: tags.md
# - mkdocstrings
- include-markdown
- git-authors
- git-revision-date-localized
extra_css:
- style.css
extra:
tags:
flex: SIL's [FieldWorks](https://software.sil.org/fieldworks/)
theme:
name: material
features:
Expand Down
4 changes: 3 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
mkdocs
pymdown-extensions
mkdocs-material
mkdocs-include-markdown-plugin
mkdocs-include-markdown-plugin
mkdocs-git-authors-plugin
mkdocs-git-revision-date-localized-plugin

0 comments on commit 8d83ccc

Please sign in to comment.