Skip to content

Commit bd5eb5d

Browse files
authored
Update readme (#163)
## Summary: Update readme with information about project. This isn't a forever readme. Eventually I'd like to see a bunch of things added: - Description of the perseus format - How to use storybooks - How to integrate perseus into a project - Ways that are helpful vs. not helpful to contribute Issue: https://khanacademy.atlassian.net/browse/FEI-4493 ## Test plan: - Do humans understand the words? - **If yes, tests pass** Author: nixterrimus Reviewers: jeremywiebe Required Reviewers: Approved by: jeremywiebe Checks: ✅ Extract i18n strings (ubuntu-latest, 16.x), ⌛ Test (ubuntu-latest, 16.x), ⌛ Lint, flow, and coverage check (ubuntu-latest, 16.x) Pull request URL: #163
1 parent 8a0c6f9 commit bd5eb5d

File tree

4 files changed

+33
-5
lines changed

4 files changed

+33
-5
lines changed
File renamed without changes.

logo.png

34.5 KB
Loading

packages/perseus/src/README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,35 @@
1-
Widgets from the Perseus (exercise) editor.
1+
# Perseus
22

3-
TODO(benkraft): Figure out the distinction between this and the various other
4-
Perseus packages.
3+
<p align="center"><img src="logo.png" alt="perseus logo" width="150px"/></p>
54

6-
Code-Owner: Learning Platform
7-
Crowdin-Category: content.chrome
5+
<p align="center">Perseus Exercise Renderer</p>
6+
7+
Perseus is Khan Academy's exercise system. This repo contains the code needed to take a problem in the perseus format and present it, allow interaction, and grade the result of a learner's work.
8+
9+
<p align="center"><img src="sample.png" alt="sample of perseus in use" height="150px"/></p>
10+
11+
This repo is a constellation of sub-repos for showing exercise content. Please see individual projects in in the `packages/` folder for more information about each sub-project.
12+
13+
## Getting started
14+
15+
### Prerequisites
16+
17+
- [Node.JS v12](https://nodejs.org/download/release/v10.18.1/)
18+
- [Yarn](https://yarnpkg.com/lang/en/docs/install/)
19+
20+
### Installation
21+
22+
To install perseus, you need to run the following commands:
23+
24+
#### `yarn install`
25+
26+
Installs project dependencies
27+
28+
## Contributing
29+
30+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for a walkthrough of how some
31+
of the Perseus code works and how to extend it.
32+
33+
## License
34+
35+
[MIT License](http://opensource.org/licenses/MIT)

sample.png

132 KB
Loading

0 commit comments

Comments
 (0)