open.source/manifold
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Shorten "Getting Started" to an numbered list

Browse Source
This commit is contained in:
Austin Chen 2022-04-26 01:32:42 -05:00 committed by GitHub
parent ba46715fcc
commit 1d93ff0cd2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -4,7 +4,13 @@ This [monorepo][] has basically everything involved in running and operating Man
## Getting started
All dependencies for everything are managed using [Yarn][yarn]. (Take care to use Yarn 1.x rather than Yarn 2 for now.) Install it and run `yarn` to install them. Then if you want to run the website locally `cd` into `web` and run `yarn dev:dev`. See [`web/README.md`][web-readme] for more details on hacking on the client in particular.
0. Make sure you have [Yarn 1.x][yarn]
1. `$ cd web`
2. `$ yarn`
3. `$ yarn dev:dev`
4. Your site will be available on http://localhost:3000
See [`web/README.md`][web-readme] for more details on hacking on the web client.
## General architecture
@ -24,6 +30,8 @@ Operations with complicated contracts (e.g. buying shares) are provided in a sep
- `og-image/`: The OpenGraph image generator; creates the preview images shown on Twitter/social media.
Also: Our docs are currently in [a separate repo](https://github.com/manifoldmarkets/docs). TODO: move them into this monorepo.
## Contributing
Since we are just now open-sourcing things, we will see how things go. Feel free to open issues, submit PRs, and chat about the process on Discord. We would prefer [small PRs][small-prs] that we can effectively evaluate and review -- maybe check in with us first if you are thinking to work on a big change.