Add readmes, etc

Author: penelopeysm

README.md

@@ -1,47 +1,39 @@
-# Svelte + TS + Vite
+# london-classical
 
-This template should help get you started developing with Svelte and TypeScript in Vite.
+Website which aggregates (some) classical music concerts in London.
 
-## Recommended IDE Setup
+This is done by scraping the websites of various venues and aggregating the data into a single page.
+The scraping is done with a small Rust application, located in the `rust` subdirectory.
 
-[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).
+The frontend is built with Svelte / TypeScript, and is in the `src` subdirectory.
 
-## Need an official Svelte framework?
 
-Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more.
+## Run locally
 
-## Technical considerations
+1. Clone the repository.
 
-**Why use this over SvelteKit?**
+   ```
+   git clone git@github.com:penelopeysm/london-classical.git
+   cd london-classical
+   ```
 
-- It brings its own routing solution which might not be preferable for some users.
-- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.
+2. Run the Rust application to generate the list of concerts.
 
-This template contains as little as possible to get started with Vite + TypeScript + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.
+   ```
+   cd rust
+   cargo run
+   ```
 
-Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.
+3. Run the website.
 
-**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?**
+   ```
+   # cd back to top level
+   npm install
+   npm run dev
+   ```
 
-Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information.
+## Generating types
 
-**Why include `.vscode/extensions.json`?**
-
-Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.
-
-**Why enable `allowJs` in the TS template?**
-
-While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not prevent the use of JavaScript syntax in `.svelte` files. In addition, it would force `checkJs: false`, bringing the worst of both worlds: not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant.
-
-**Why is HMR not preserving my local component state?**
-
-HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/rixo/svelte-hmr#svelte-hmr).
-
-If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.
-
-```ts
-// store.ts
-// An extremely simple external store
-import { writable } from 'svelte/store'
-export default writable(0)
-```
+The types associated with concerts are defined in `rust/src/core.rs`.
+These types are exported to TypeScript using `ts-rs`, and live inside `src/`
+To update the TypeScript bindings: run `make types` from the `rust` subdirectory.

rust/Makefile

@@ -0,0 +1,2 @@
+types:
+	cargo test && rm -r ../src/lib/bindings && mv bindings ../src/lib

rust/README.md

@@ -1 +1,3 @@
-Learning Rust, because why not.
+This is a Rust application which fetches details about classical concerts in London from the Internet for the frontend to display.
+
+See `README.md` in the main repo for more information.