# spiral

<https://fc1943s.github.io/spiral>

[![깃허브 코드스페이스](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=1083700386)

---

- [Getting Started](#getting-started)
  - [Installation](#installation)
- [Links](#links)
- [Contributing](#contributing)
- [License](#license)

## Getting Started

### Installation

Clone the repository:

```powershell
git clone https://github.com/fc1943s/spiral.git
```

Navigate to the directory, initialize dependencies and build the project:

```powershell
cd spiral
pwsh scripts/workflow.ps1
```

## Links

<table>

<tr>
<td>

Documentation

</td>
<td>

- Repository file tree (HTML)  
<https://fc1943s.github.io/spiral>

</td>
</tr>

<tr>
<td>

Samples

</td>
<td>

- Spiral CLI notebook  
<https://fc1943s.github.io/spiral/apps/spiral/spiral.dib.html>

- Spiral compiler notebook  
<https://fc1943s.github.io/spiral/apps/compiler/spiral_compiler.dib.html>

- Parsing library  
<https://fc1943s.github.io/spiral/lib/spiral/parsing.dib.html>

- Physics notebook from the "Learn Physics with Functional Programming" book  
<https://fc1943s.github.io/spiral/lib/spiral/physics.dib.html>

</td>
</tr>

<tr>
<td>

Social

</td>
<td>

- Spiral ChatGPT pitch conversation (en-US)  
<https://chat.openai.com/share/62ae3405-4d5f-4cff-a7d9-10ed67cc7cf2>

- Spiral ChatGPT pitch conversation (pt-BR)  
<https://chat.openai.com/share/1ad5a1de-ca7a-4d26-8594-f1901c56281c>

- Forum Post (pt-BR): Pitch: A linguagem de programação Spiral  
<https://www.tabnews.com.br/i574n/pitch-a-linguagem-de-programacao-spiral-chatgpt>

</td>
</tr>

</table>

## Contributing

Contributions are welcome! Please see the [CONTRIBUTING.md](https://github.com/fc1943s/.github/blob/main/CONTRIBUTING.md) for guidelines.

## License

This project is licensed under the AGPLv3 License. See the [LICENSE](https://github.com/fc1943s/spiral/blob/main/LICENSE) file for details.