File tree Expand file tree Collapse file tree 2 files changed +18
-7
lines changed Expand file tree Collapse file tree 2 files changed +18
-7
lines changed Original file line number Diff line number Diff line change 1
1
# Bourse
2
2
3
- Rust market-simulator with Python API
3
+ Rust market-simulator with a Python API
4
4
5
5
## Python
6
6
7
+ Full documentation can be found
8
+ [ here] ( https://zombie-einstein.github.io/bourse/ ) .
9
+
7
10
### Getting Started
8
11
9
12
Bourse can be installed via pip
@@ -14,17 +17,23 @@ pip install bourse
14
17
15
18
### Examples
16
19
17
- See [ here] ( examples/ ) for simulation examples.
20
+ See [ here] ( examples/ ) for simulation examples and
21
+ [ the docs] ( https://zombie-einstein.github.io/bourse/pages/example.html )
22
+ for an annotated example.
18
23
19
24
## Rust
20
25
21
26
### Getting Started
22
27
23
- The library consists of two core
24
- crates:
28
+ The library consists of two core crates:
29
+
30
+ - ` bourse-book ` a library implementing a market order
31
+ book. Full documentation can be found
32
+ [ here] ( https://docs.rs/bourse-book/0.1.0/bourse_book/ ) .
25
33
26
- - ` bourse-book ` an library implementing an market order book
27
- - ` bourse-de ` a discrete-event market simulation library
34
+ - ` bourse-de ` a discrete-event market simulation library.
35
+ Full documentation can be found
36
+ [ here] ( https://docs.rs/bourse-de/0.1.0/bourse_de/ )
28
37
29
38
Both can be installed using cargo
30
39
Original file line number Diff line number Diff line change @@ -34,7 +34,9 @@ dependencies = [
34
34
]
35
35
36
36
[project .urls ]
37
- Source = " https://github.com/zombie-einstein/bourse"
37
+ source = " https://github.com/zombie-einstein/bourse"
38
+ docs = " https://zombie-einstein.github.io/bourse/"
39
+ documentation = " https://zombie-einstein.github.io/bourse/"
38
40
39
41
[tool .hatch .envs .dev ]
40
42
dependencies = [
You can’t perform that action at this time.
0 commit comments