You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Meantonal is a specification for representing pitch information in Western music, and a suite of tools for operating on this information. It's a small, focused library that aims to empower developers to build musical apps more easily.
14
+
15
+
Meantonal is:
16
+
17
+
-**Flexible with I/O**: easily ingest and translate between Scientific Pitch Notation, Helmholtz notation, ABC and Lilypond. Extract MIDI values at any time.
18
+
-**Semantically nondestructive**: the distinction between enharmonic notes such as $\sf{C}\sharp$ and $\sf{D}\flat$ is maintained. Things that don't behave the same way musically are not encoded the same way in Meantonal.
19
+
-**Just vectors**: under the hood [pitches](https://meantonal.org/learn/pitch/) and [intervals](https://meantonal.org/learn/intervals/) are 2d vectors. Operations are simple to understand, surprisingly powerful, and fast to execute.
20
+
-**Tuning-agnostic**: Target any meantone tuning system, not just 12-tone equal temperament. You want 31 tones per octave? Done.
21
+
22
+
This is the repository for the companion documentation website for Meantonal. As an open source project, contributions are welcome! The information below will help you get started.
Then, `cd` into the new directory and run `npm install`:
33
+
34
+
```bash
35
+
cd documentation && npm install
7
36
```
8
37
9
-
> π§βπ **Seasoned astronaut?** Delete this file. Have fun!
38
+
Now you can run `npm run dev` to spin up a dev server and start editing!
10
39
11
-
## π Project Structure
40
+
## Project Structure
12
41
13
-
Inside of your Astro + Starlight project, you'll see the following folders and files:
42
+
The documentation site is an Astro + Starlight project. Inside the root directory, you'll see the following folders and files:
14
43
15
44
```
16
45
.
@@ -19,6 +48,7 @@ Inside of your Astro + Starlight project, you'll see the following folders and f
19
48
β βββ assets/
20
49
β βββ content/
21
50
β β βββ docs/
51
+
β βββ pages/
22
52
β βββ styles/
23
53
β β βββ global.css
24
54
β βββ content.config.ts
@@ -33,9 +63,9 @@ Images can be added to `src/assets/` and embedded in Markdown with a relative li
33
63
34
64
Static assets, like favicons, can be placed in the `public/` directory.
35
65
36
-
The project includes [Tailwind CSS](https://starlight.astro.build/guides/css-and-tailwind/#tailwind-css) for styling. Customize your design by modifying `src/styles/global.css`.
66
+
The project includes [Tailwind CSS](https://starlight.astro.build/guides/css-and-tailwind/#tailwind-css) for styling. Customize by modifying `src/styles/global.css`.
37
67
38
-
## π§ Commands
68
+
## Commands
39
69
40
70
All commands are run from the root of the project, from a terminal:
41
71
@@ -47,7 +77,3 @@ All commands are run from the root of the project, from a terminal:
47
77
|`npm run preview`| Preview your build locally, before deploying |
48
78
|`npm run astro ...`| Run CLI commands like `astro add`, `astro check`|
49
79
|`npm run astro -- --help`| Get help using the Astro CLI |
50
-
51
-
## π Want to learn more?
52
-
53
-
Check out [Starlightβs docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
0 commit comments