git.iko.soy/project-m36
on master help sign in
update documentation to reference new docker downloads
fbdbec7AgentM
README.markdown+6
compare with master
unifiedsplit
@@ -34,6 +34,12 @@ Project:M36 supports multiple frontends which target different audiences.
34* store and manipulate databases
34* store and manipulate databases
35* use Project:M36 as a native Haskell database backend
35* use Project:M36 as a native Haskell database backend
36
36
37+## Download
38+
39+Project:M36 can be downloaded and run via docker, which supports Windows 10, macOS, and Linux.
40+
41+Run `docker run projectm36/project-m36 tutd` to start the TutorialD command line interface.
42+
37## Community
43## Community
38
44
39* [Developer's Blog](https://agentm.github.io/project-m36/)
45* [Developer's Blog](https://agentm.github.io/project-m36/)
docs/introduction_to_projectm36.markdown+25−6
@@ -15,16 +15,35 @@ The relational algebra is the mathematical model underpinning Project:M36. When
15
15
16## Binary Releases
16## Binary Releases
17
17
18−### Windows
18+The quickest and preferred method of installation is via docker, which works on Linux, macOS, and Windows. Docker downloads and runs preconfigured software in secure, sandboxed containers, preventing third-party software from altering the host system without your permission.
19−Project:M36 now provides binary installations for Windows. Check the (releases page)[https://github.com/agentm/project-m36/releases] for downloads.
20
19
21−### MacOS X
20+### Install Docker:
22
21
23−Binary releases are not yet available for MacOS X, but compiling from source is easy.
22+* [Windows 10 Docker Installation](https://docs.docker.com/docker-for-windows/wsl/)
23+* [MacOS Docker Installation](https://docs.docker.com/docker-for-mac/install/)
24+* [Linux Docker Installation](https://docs.docker.com/engine/install/#server)
24
25
25−### Linux
26+### Run TutorialD from Docker Image
26
27
27−The currently-preferred method of installation is from source. A future enhancement would be installation from deb or rpm.
28+This downloads the docker image tagged "latest" and runs `tutd`, the TutorialD command line interface. Try the [15-Minute TutorialD Tutorial](15_minute_tutorial.markdown) and try some expressions.
29+
30+```bash
31+docker run -it projectm36/project-m36 tutd
32+```
33+
34+### Run Project:M36 Server
35+
36+The default port for the project-m36 server is 6543.
37+
38+```bash
39+docker run --network host projectm36/project-m36 project-m36-server -n <database_name>
40+```
41+
42+### Connect to Project:M36 Server
43+
44+```bash
45+docker run --network host projectm36/project-m36
46+```
28
47
29## Source Installation
48## Source Installation
30
49