Skip to content

Commit

Permalink
Addition : listing .pdf as alternative source
Browse files Browse the repository at this point in the history
  • Loading branch information
Bubobubobubobubo committed Feb 23, 2024
1 parent 2ee66cd commit 8b10af5
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 16 deletions.
Binary file added src/documentation/basics/TOPOS_COMMANDS.pdf
Binary file not shown.
37 changes: 21 additions & 16 deletions src/documentation/basics/welcome.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { makeExampleFactory, key_shortcut } from "../../Documentation";
import { type Editor } from "../../main";
import { examples } from "../../examples/excerpts";
import pdf from "./TOPOS_COMMANDS.pdf";

export const introduction = (application: Editor): string => {
const makeExample = makeExampleFactory(application);
Expand All @@ -12,30 +13,30 @@ Welcome to the **Topos** documentation. You can jump here anytime by pressing ${
)}. Press again to make the documentation disappear. Contributions are much appreciated! The documentation [lives here](https://github.com/Bubobubobubobubo/topos/tree/main/src/documentation).
${makeExample(
"Welcome! Eval to get started",
examples[Math.floor(Math.random() * examples.length)],
true,
)}
"Welcome! Eval to get started",
examples[Math.floor(Math.random() * examples.length)],
true,
)}
# What is Topos?
Topos is an _algorithmic_ sequencer. Topos is also a _live coding_ environment. To sum it up, think: "_making music in real time through code_". Code used as an expressive medium for musical improvisation! Topos uses small algorithms to represent musical sequences and processes.
${makeExample(
"Small algorithms for direct musical expression",
`
"Small algorithms for direct musical expression",
`
rhythm(.5, 4, 8) :: sound('drum').out()
rhythm(.25, [5, 7].beat(2), 8) :: sound(['hc', 'fikea', 'hat'].pick(1))
.lpf([500, 4000+usine(1/2)*2000]).pan(r(0, 1)).ad(0, [1, .5])
.db(-ir(1,8)).speed([1,[0.5, 2].pick()]).room(0.5).size(3).o(4).out()
beat([2,0.5].dur(13.5, 0.5))::snd('fsoftsnare')
.n(0).speed([1, 0.5]).o(4).out()`,
false,
)}
false,
)}
${makeExample(
"Computer music should be immediate and intuitive",
`
"Computer music should be immediate and intuitive",
`
let chord_prog = [0, 0, 5].bar() // Chord progression
beat(.25)::snd('sine')
.note(chord_prog + [60, 64, 67, 71].mouseX()
Expand All @@ -47,19 +48,19 @@ beat(.25)::snd('sine')
.delay(0.5).delayt(0.25).delayfb(0.7) // Delay
.room(0.5).size(8) // Reverb
.out()`,
false,
)}
false,
)}
${makeExample(
"Making the web less dreadful, one beep at at time",
`
"Making the web less dreadful, one beep at at time",
`
beat(.5) :: sound('sid').n($(2))
.room(1).speed([1,2].pick()).out()
beat(.25) :: sound('sid').note(
[34, 36, 41].beat(.25) + [[0,-24].pick(),12].beat())
.room(0.9).size(0.9).n(4).out()`,
false,
)}
false,
)}
Topos is deeply inspired by the [Monome Teletype](https://monome.org/). The Teletype is/was an open source hardware module for Eurorack synthesizers. While the Teletype was initially born as an hardware module, Topos aims to be a web-browser based cousin of it! It is a sequencer, a scriptable interface, a companion for algorithmic music-making. Topos wishes to fullfill the same goal as the Teletype, keeping the same spirit alive on the web. It is free, open-source, and made to be shared and used by everyone. Learn more about live coding on [livecoding.fr](https://livecoding.fr).
Expand All @@ -69,6 +70,10 @@ Reloading the application will get you one random song example to study every ti
"F5",
)} and listen to them all! The demo songs are also used a bit everywhere in the documentation to illustrate some of the working principles :).
## Alternative documentation source (.pdf)
You can also find a .pdf version listing the principal commands and functions [here](${pdf}). This document has been generated by Chris Collis. It recaps the main sections of this documentation and can be a good companion while learning Topos.
## Support
<p>You can <a href='https://ko-fi.com/I2I2RSBHF' target='_blank'><img height='36' style='display: inline; border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi3.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a> to support the development :) </p>
Expand Down

0 comments on commit 8b10af5

Please sign in to comment.