https://github.com/lambdamusic/xtm-docs
Unofficial functions documentation for the Extempore programming language
https://github.com/lambdamusic/xtm-docs
algorithmic-composition documentation extempore livecoding
Last synced: about 2 months ago
JSON representation
Unofficial functions documentation for the Extempore programming language
- Host: GitHub
- URL: https://github.com/lambdamusic/xtm-docs
- Owner: lambdamusic
- License: mit
- Created: 2021-11-01T15:45:37.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-06T07:37:35.000Z (about 1 year ago)
- Last Synced: 2025-01-12T20:08:14.605Z (3 months ago)
- Topics: algorithmic-composition, documentation, extempore, livecoding
- Language: HTML
- Homepage: https://extempore.michelepasin.org/
- Size: 58.3 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Extempore Function Documentation generator
A Python/Django application for navigating the Extempore codebase.
The app allows to extract functions definitions from Extempore's source code, save it into a database and render it via a simple HTML interface.
Online: http://extempore.michelepasin.org/
## Building the Extempore functions index
First of all, set the path to your local extempore source repo in `local_settings.py`, using the `XTM_LOCAL_FILES` variable.
```bash
$ python manage.py parse_xtm
```
or the helper script:
```bash
$ ./tools/load-xtm-src
```
## Running the Django app
```bash
./tools/run-dev-local-db
```
## Development
With Python 3.9 and [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/index.html)
```bash
$ git clone [email protected]:lambdamusic/xtm-docs.git
$ mkvirtualenv xtmdocs
$ pip install -r requirements.txt
```
Then adjust your local settings in `src/local_settings_example.py`
```bash
$ cp src/local_settings_example.py src/src/local_settings.py
$ open src/local_settings.py
```
In particular this part
```python
XTM_VERSION = "v0.8.9"
XTM_GITHUB_URL = "https://github.com/digego/extempore/tree/" + XTM_VERSION
# LOCATION OF EXTEMPORE SRC
XTM_LOCAL_FILES = ['/Applications/path/to/extempore']
# =====================
```
## Project status
Just an idea, but feel free to get in touch if you're willing to improve/extend it.
## Changelog
### February 26, 2023
* show GitHub source url in search pages
* improve about section
### March 7, 2022
* improved search
* improve code extraction with comments before functions
### December 13, 2021
* adding site search in front end
* reorg urls
* make a unique URL for function index (both custom and not)
* make list pages functions list
* updated fundetails so that it takes '.html' version of pages
## Links
* http://extempore.michelepasin.org/
* http://extempore.moso.com.au/
* https://github.com/digego/extempore