Skip to content

Commit b1d9c8d

Browse files
authored
Update README.md
1 parent 4f279de commit b1d9c8d

File tree

1 file changed

+38
-12
lines changed

1 file changed

+38
-12
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,45 @@
1-
# Starlight Starter Kit: Tailwind
2-
31
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
42

3+
# Table of Contents
4+
5+
- [Meantonal](#meantonal)
6+
- [Project Structure](#project-structure)
7+
- [Commands](#commands)
8+
9+
<img align="left" src="/src/assets/logo.svg" width="48">
10+
11+
# Meantonal
12+
13+
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.
23+
24+
## Getting Started
25+
26+
First, clone the repo:
27+
28+
```bash
29+
https://github.com/meantonal/documentation.git
530
```
6-
npm create astro@latest -- --template starlight/tailwind
31+
32+
Then, `cd` into the new directory and run `npm install`:
33+
34+
```bash
35+
cd documentation && npm install
736
```
837

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!
1039

11-
## πŸš€ Project Structure
40+
## Project Structure
1241

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:
1443

1544
```
1645
.
@@ -19,6 +48,7 @@ Inside of your Astro + Starlight project, you'll see the following folders and f
1948
β”‚ β”œβ”€β”€ assets/
2049
β”‚ β”œβ”€β”€ content/
2150
β”‚ β”‚ └── docs/
51+
β”‚ β”œβ”€β”€ pages/
2252
β”‚ β”œβ”€β”€ styles/
2353
β”‚ β”‚ └── global.css
2454
β”‚ └── content.config.ts
@@ -33,9 +63,9 @@ Images can be added to `src/assets/` and embedded in Markdown with a relative li
3363

3464
Static assets, like favicons, can be placed in the `public/` directory.
3565

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`.
3767

38-
## 🧞 Commands
68+
## Commands
3969

4070
All commands are run from the root of the project, from a terminal:
4171

@@ -47,7 +77,3 @@ All commands are run from the root of the project, from a terminal:
4777
| `npm run preview` | Preview your build locally, before deploying |
4878
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
4979
| `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

Comments
Β (0)